diff --git a/docs/settings.rst b/docs/settings.rst index 3fac5f18..a481bfe4 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -496,6 +496,7 @@ This would save your articles into something like Defines whether Pelican should use document-relative URLs or not. Only set this to ``True`` when developing/testing and only if you fully understand the effect it can have on links/feeds. The default is ``False``. + This option is enabled by default if you use github pages. .. data:: ARTICLE_URL diff --git a/pelican/tools/templates/Makefile.jinja2 b/pelican/tools/templates/Makefile.jinja2 index 467b1976..5f393d7f 100644 --- a/pelican/tools/templates/Makefile.jinja2 +++ b/pelican/tools/templates/Makefile.jinja2 @@ -46,7 +46,12 @@ ifeq ($(DEBUG), 1) PELICANOPTS += -D endif +{% if github %} +RELATIVE ?= 1 +{% else %} RELATIVE ?= 0 +{% endif %} + ifeq ($(RELATIVE), 1) PELICANOPTS += --relative-urls endif diff --git a/pelican/tools/templates/publishconf.py.jinja2 b/pelican/tools/templates/publishconf.py.jinja2 index 301e4dfa..f46913ed 100755 --- a/pelican/tools/templates/publishconf.py.jinja2 +++ b/pelican/tools/templates/publishconf.py.jinja2 @@ -9,7 +9,12 @@ from pelicanconf import * # If your site is available via HTTPS, make sure SITEURL begins with https:// SITEURL = "{{siteurl}}" + +{{ if github }} RELATIVE_URLS = False +{{ else }} +RELATIVE_URLS = True +{{ endif }} FEED_ALL_ATOM = "feeds/all.atom.xml" CATEGORY_FEED_ATOM = "feeds/{slug}.atom.xml"