weeheavy/pelican-theme
1
0
Fork 0
forked from github/pelican
Code Pull requests Activity

Use better headers in tips docs

Browse source 
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.
This commit is contained in:
Sjoerd 2017-01-14 13:51:10 +01:00
commit d61e2ccd6b
1 changed files with 6 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

14
docs/tips.rst
View file

@ -105,10 +105,8 @@ Custom 404 Pages
GitHub Pages will display the custom 404 page described above, as noted in the
relevant `GitHub docs <https://help.github.com/articles/custom-404-pages/>`_.
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
<https://help.github.com/articles/setting-up-a-custom-domain-with-pages>`_ 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
==================================