From d61e2ccd6ba051ff581cc356c384936d240ea495 Mon Sep 17 00:00:00 2001 From: Sjoerd Date: Sat, 14 Jan 2017 13:51:10 +0100 Subject: [PATCH] Use better headers in tips docs Instead of "Tip 1", "Tip 2" under "Extra tips", use headers describing the content. Also, remove the "hint" pointer as it is not really a hint and the document consists of tips anyway. --- docs/tips.rst | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/docs/tips.rst b/docs/tips.rst index 9f45f877..50160380 100644 --- a/docs/tips.rst +++ b/docs/tips.rst @@ -105,10 +105,8 @@ Custom 404 Pages GitHub Pages will display the custom 404 page described above, as noted in the relevant `GitHub docs `_. -Extra Tips ----------- - -Tip #1: +Update your site on each commit +------------------------------- To automatically update your Pelican site on each commit, you can create a post-commit hook. For example, you can add the following to @@ -116,7 +114,8 @@ a post-commit hook. For example, you can add the following to pelican content -o output -s pelicanconf.py && ghp-import output && git push origin gh-pages -Tip #2: +Copy static files to the root of your site +------------------------------------------ To use a `custom domain `_ with @@ -131,9 +130,8 @@ output directory. For example:: Note: use forward slashes, ``/``, even on Windows. -.. hint:: - You can also use the ``EXTRA_PATH_METADATA`` mechanism - to place a ``favicon.ico`` or ``robots.txt`` at the root of any site. +You can also use the ``EXTRA_PATH_METADATA`` mechanism +to place a ``favicon.ico`` or ``robots.txt`` at the root of any site. How to add YouTube or Vimeo Videos ==================================