chiark / gitweb /
doc: properly document what BLOGURL and BLOGNAME do.
authorVladimír Vondruš <mosra@centrum.cz>
Tue, 24 Oct 2017 15:32:42 +0000 (17:32 +0200)
committerVladimír Vondruš <mosra@centrum.cz>
Tue, 24 Oct 2017 15:33:14 +0000 (17:33 +0200)
And also *use* them. Ugh.

doc/pelican/theme.rst
site/pelicanconf.py

index a045ef664e6d3a20fa878309caf82a8daec64744..7bcb7bd8436b6f82b37cf90a0696df75ff6c9dcc 100644 (file)
@@ -84,6 +84,22 @@ for publishing.
 `Configuration`_
 ================
 
+Value of :py:`SITENAME` is used in the :html:`<title>` tag, separated with a
+``|`` character from page title. If page title is the same as :py:`SITENAME`
+(for example on the index page), only the page title is shown. The static part
+of the website with pages is treated differently from the "blog" part with
+articles and there are two additional configuration options :py:`BLOGURL` and
+:py:`BLOGNAME` that control how various parts of the theme link to the blog and
+how blog pages are named in the :html:`<title>` element.
+
+.. code:: py
+
+    SITENAME = 'Your Brand'
+    SITEURL = ''
+
+    BLOGNAME = 'Your Brand Blog'
+    BLOGURL = '/blog'
+
 Theme color :html:`<meta>` tag used by `CSS themes`_ can be specified with
 the :py:`THEME_COLOR` variable. If not set, no theme color :html:`<meta>` tag
 is present. Example configuration for the builtin dark theme:
@@ -92,10 +108,6 @@ is present. Example configuration for the builtin dark theme:
 
     THEME_COLOR = '#22272e'
 
-Value of :py:`SITENAME` is used in the :html:`<title>` tag, separated with a
-``|`` character from page / article title. If page title is the same as
-:py:`SITENAME` (for example on the index page), only the page title is shown.
-
 `Top navbar`_
 -------------
 
index a290b32eea109ef2e04583a9358e47c101bbfbd0..29eeba810c87647678b4cc044afee735dd786815 100644 (file)
@@ -28,6 +28,10 @@ SITE_LOGO_TEXT = 'm.css'
 
 SITENAME = 'm.css'
 SITEURL = ''
+
+BLOGNAME = 'm.css example articles'
+BLOGURL = '/examples'
+
 STATIC_URL = '/{path}'
 
 PATH = 'content'