From 9cbd3245657e9cf1e272a7035947526860b7b69f Mon Sep 17 00:00:00 2001 From: =?utf8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Tue, 24 Oct 2017 17:32:42 +0200 Subject: [PATCH] doc: properly document what BLOGURL and BLOGNAME do. And also *use* them. Ugh. --- doc/pelican/theme.rst | 20 ++++++++++++++++---- site/pelicanconf.py | 4 ++++ 2 files changed, 20 insertions(+), 4 deletions(-) diff --git a/doc/pelican/theme.rst b/doc/pelican/theme.rst index a045ef66..7bcb7bd8 100644 --- a/doc/pelican/theme.rst +++ b/doc/pelican/theme.rst @@ -84,6 +84,22 @@ for publishing. `Configuration`_ ================ +Value of :py:`SITENAME` is used in the :html:`` 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`_ ------------- diff --git a/site/pelicanconf.py b/site/pelicanconf.py index a290b32e..29eeba81 100644 --- a/site/pelicanconf.py +++ b/site/pelicanconf.py @@ -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' -- 2.30.2