diff --git a/docs/tips.rst b/docs/tips.rst index 50160380..fab9145b 100644 --- a/docs/tips.rst +++ b/docs/tips.rst @@ -46,6 +46,11 @@ Project Pages and User Pages. Project Pages ------------- +.. note:: + + ``RELATIVE_URLS`` must be set to ``True`` when you deploy on GitHub as a + Project Page. Otherwise the links to the static files are wrong. + To publish a Pelican site as a Project Page you need to *push* the content of the ``output`` dir generated by Pelican to a repository's ``gh-pages`` branch on GitHub.