github/pelican
1
0
Fork 1
mirror of https://github.com/getpelican/pelican.git synced 2025-10-15 20:28:56 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Clarify docs for specifying theme. Closes #475.

Browse source
This commit is contained in:
Justin Mayer 2012-09-11 07:29:34 -07:00 • committed by Alexis Métaireau
commit f7a28dc661
1 changed files with 27 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

48
docs/settings.rst
View file

@ -377,19 +377,19 @@ Setting name (default value) What does it do?
alphabetical order; default lists alphabetically.) alphabetical order; default lists alphabetically.)
================================================ ===================================================== ================================================ =====================================================
Theming Themes
======= ======
Theming is addressed in a dedicated section (see :ref:`theming-pelican`). Creating Pelican themes is addressed in a dedicated section (see :ref:`theming-pelican`).
However, here are the settings that are related to theming. However, here are the settings that are related to themes.
================================================ ===================================================== ================================================ =====================================================
Setting name (default value) What does it do? Setting name (default value) What does it do?
================================================ ===================================================== ================================================ =====================================================
`THEME` Theme to use to produce the output. Can be the `THEME` Theme to use to produce the output. Can be a relative
complete static path to a theme folder, or or absolute path to a theme folder, or the name of a
chosen between the list of default themes (see default theme or a theme installed via
below) ``pelican-themes`` (see below).
`THEME_STATIC_PATHS` (``['static']``) Static theme paths you want to copy. Default `THEME_STATIC_PATHS` (``['static']``) Static theme paths you want to copy. Default
value is `static`, but if your theme has value is `static`, but if your theme has
other static paths, you can put them here. other static paths, you can put them here.
@ -397,22 +397,32 @@ Setting name (default value) What does it do?
`WEBASSETS` (``False``) Asset management with `webassets` (see below) `WEBASSETS` (``False``) Asset management with `webassets` (see below)
================================================ ===================================================== ================================================ =====================================================
By default, two themes are available. You can specify them using the `-t` option:
By default, two themes are available. You can specify them using the `THEME` setting or by passing the
``-t`` option to the ``pelican`` command:
* notmyidea * notmyidea
* simple (a synonym for "full text" :) * simple (a synonym for "plain text" :)
You can define your own theme too, and specify its placement in the same
manner. (Be sure to specify the full absolute path to it.)
Here is :doc:`a guide on how to create your theme <themes>`
You can find a list of themes at http://github.com/getpelican/pelican-themes.
There are a number of other themes available at http://github.com/getpelican/pelican-themes.
Pelican comes with :doc:`pelican-themes`, a small script for managing themes. Pelican comes with :doc:`pelican-themes`, a small script for managing themes.
The `notmyidea` theme can make good use of the following settings. I recommend You can define your own theme, either by starting from scratch or by duplicating
using them in your themes as well. and modifying a pre-existing theme. Here is :doc:`a guide on how to create your theme <themes>`.
Following are example ways to specify your preferred theme::
# Specify name of a built-in theme
THEME = "notmyidea"
# Specify name of a theme installed via the pelican-themes tool
THEME = "chunk"
# Specify a customized theme, via path relative to the settings file
THEME = "themes/mycustomtheme"
# Specify a customized theme, via absolute path
THEME = "~/projects/mysite/themes/mycustomtheme"
The built-in `notmyidea` theme can make good use of the following settings. Feel
free to use them in your themes as well.
======================= ======================================================= ======================= =======================================================
Setting name What does it do ? Setting name What does it do ?