mirror of
https://github.com/getpelican/pelican.git
synced 2025-10-15 20:28:56 +02:00
include the default values of the settings in the 1st column in parens
this way, it is much easier for the reader to see which variable has which default value. I also added some default values which could not be found in the documentation before.
This commit is contained in:
derdon
parent
fcab48a5e5
commit
c9f9f4e500
1 changed files with 79 additions and 78 deletions
|
|
@ -20,84 +20,85 @@ Here are the available settings. Please note that all the settings you put in
|
||||||
this file will be passed to the templates as well.
|
this file will be passed to the templates as well.
|
||||||
|
|
||||||
|
|
||||||
======================== =======================================================
|
================================================ =====================================================
|
||||||
Setting name what it does ?
|
Setting name (default value) what does it do?
|
||||||
======================== =======================================================
|
================================================ =====================================================
|
||||||
`AUTHOR` Default author (put your name)
|
`AUTHOR` Default author (put your name)
|
||||||
`CATEGORY_FEED` Where to put the atom categories feeds. default is
|
`CATEGORY_FEED` ('feeds/%s.atom.xml'[1]_) Where to put the atom categories feeds.
|
||||||
`feeds/%s.atom.xml`, where %s is the name of the
|
`CATEGORY_FEED_RSS` (``None``, i.e. no RSS) Where to put the categories rss feeds.
|
||||||
category.
|
`CSS_FILE` (``'main.css'``) specify the CSS file you want to load
|
||||||
`CATEGORY_FEED_RSS` Where to put the categories rss feeds. default is None
|
`DATE_FORMATS` (``{}``) If you do manage multiple languages, you can
|
||||||
(no rss)
|
set the date formatting here.
|
||||||
`CSS_FILE` To specify the CSS file you want to load, if it's not
|
`DEFAULT_CATEGORY` (``'misc'``) The default category to fallback on.
|
||||||
the default one ('main.css')
|
`DEFAULT_DATE_FORMAT` (``'%a %d %B %Y'``) The default date format you want to use.
|
||||||
`DATE_FORMATS` If you do manage multiple languages, you can set
|
`DEFAULT_LANG` (``'en'``) The default language to use.
|
||||||
the date formatting here.
|
`DEFAULT_ORPHANS` (0) The minimum number of articles allowed on the
|
||||||
`DEFAULT_CATEGORY` The default category to fallback on. `misc` by default.
|
last page. Use this when you don't want to
|
||||||
`DEFAULT_DATE_FORMAT` The default date format you want to use.
|
have a last page with very few articles.
|
||||||
`DEFAULT_LANG` The default language to use. Default is 'en'.
|
`DEFAULT_PAGINATION` (5) The maximum number of articles to include on a
|
||||||
`DEFAULT_ORPHANS` The minimum number of articles allowed on the last
|
page, not including orphans.
|
||||||
page, defaults to zero. Use this when you don't want
|
`DISPLAY_PAGES_ON_MENU` (``True``) Display or not the pages on the menu of the
|
||||||
to have a last page with very few articles.
|
template. Templates can follow or not this
|
||||||
`DEFAULT_PAGINATION` The maximum number of articles to include on a page,
|
settings.
|
||||||
not including orphans. Default is 5.
|
`FALLBACK_ON_FS_DATE` (``True``) If True, pelican will use the file system
|
||||||
`DISPLAY_PAGES_ON_MENU` Display or not the pages on the menu of the template.
|
dates infos (mtime) if it can't get
|
||||||
Templates can follow or not this settings.
|
informations from the metadata?
|
||||||
`FALLBACK_ON_FS_DATE` If True, pelican will use the file system dates infos
|
`FEED` (``'feeds/all.atom.xml'``) relative url to output the atom feed.
|
||||||
(mtime) if it can't get informations from the
|
`FEED_RSS` (``None``, i.e. no RSS) relative url to output the rss feed.
|
||||||
metadata?
|
`JINJA_EXTENSIONS` (``[]``) A list of any Jinja2 extensions you want to use.
|
||||||
`FEED` relative url to output the atom feed. Default is
|
`KEEP_OUTPUT_DIRECTORY` (``False``) Keep the output directory and just update all
|
||||||
`feeds/all.atom.xml`
|
the generated files.
|
||||||
`FEED_RSS` relative url to output the rss feed. Default is
|
`LOCALE` (''[2]_) Change the locale.
|
||||||
None (no rss)
|
`MARKUP` (``('rst', 'md')``) A list of available markup languages you want
|
||||||
`JINJA_EXTENSIONS` A list of any Jinja2 extensions you want to use.
|
to use. For the moment, only available values
|
||||||
Default is no extensions (the empty list).
|
are `rst` and `md`.
|
||||||
`KEEP_OUTPUT_DIRECTORY` Keep the output directory and just update all the
|
`OUTPUT_PATH` (``'output/'``) Where to output the generated files.
|
||||||
generated files.
|
`PATH` (``None``) path to look at for input files.
|
||||||
`LOCALE` Change the locale. Default is the system locale.
|
`PDF_PROCESSOR` (``False``) Set to True if you want to have PDF versions
|
||||||
Default is to delete the output directory.
|
of your documents. You will need to install
|
||||||
`MARKUP` A list of available markup languages you want to use.
|
`rst2pdf`.
|
||||||
For the moment, only available values are `rst` and `md`.
|
`RELATIVE_URL` (``True``) Defines if pelican should use relative urls or
|
||||||
`OUTPUT_PATH` Where to output the generated files. Default to
|
not.
|
||||||
"output"
|
`REVERSE_ARCHIVE_ORDER` (``False``) Reverse the archives order. (True makes it in
|
||||||
`PATH` path to look at for input files.
|
descending order: the newer first)
|
||||||
`PDF_PROCESSOR` Put True if you want to have PDF versions of your
|
`REVERSE_CATEGORY_ORDER` (``False``) Reverse the category order. (True makes it in
|
||||||
documents. You will need to install `rst2pdf`.
|
descending order, default is alphabetically)
|
||||||
`RELATIVE_URL` Defines if pelican should use relative urls or not.
|
`SITEURL` base URL of your website. Note that this is
|
||||||
It is set to True per default.
|
not a way to tell pelican to use relative urls
|
||||||
`REVERSE_ARCHIVE_ORDER` Reverse the archives order. (True makes it in
|
or static ones. You should rather use the
|
||||||
descending order: the newer first)
|
`RELATIVE_URL` setting for such use.
|
||||||
`REVERSE_CATEGORY_ORDER` Reverse the category order. (True makes it in
|
`SITENAME` (``'A Pelican Blog'``) Your site name,
|
||||||
descending order, default is alphabetically)
|
`SKRIBIT_TYPE` The type of skribit widget (TAB or WIDGET).
|
||||||
`SITEURL` base URL of your website. Note that this is not
|
`SKRIBIT_TAB_COLOR` Tab color (#XXXXXX, default #333333).
|
||||||
a way to tell pelican to use relative urls or
|
`SKRIBIT_TAB_HORIZ` Tab Distance from Left (% or distance, default Null).
|
||||||
static ones. You should rather use the `RELATIVE_URL`
|
`SKRIBIT_TAB_VERT` Tab Distance from Top (% or distance, default 20%).
|
||||||
setting for such use.
|
`SKRIBIT_TAB_PLACEMENT` Tab placement (Top, Bottom, Left or Right,
|
||||||
`SITENAME` Your site name,
|
default LEFT).
|
||||||
`SKRIBIT_TYPE` The type of skribit widget (TAB or WIDGET).
|
`SKRIBIT_TAB_SITENAME` Tab identifier (See Skribit part below).
|
||||||
`SKRIBIT_TAB_COLOR` Tab color (#XXXXXX, default #333333).
|
`SKRIBIT_WIDGET_ID` Widget identifier (See Skribit part below).
|
||||||
`SKRIBIT_TAB_HORIZ` Tab Distance from Left (% or distance, default Null).
|
`STATIC_PATHS` The static paths you want to have accessible
|
||||||
`SKRIBIT_TAB_VERT` Tab Distance from Top (% or distance, default 20%).
|
(``['images']``) on the output path "static". By default,
|
||||||
`SKRIBIT_TAB_PLACEMENT` Tab placement (Top, Bottom, Left or Right, default
|
pelican will copy the 'images' folder to the
|
||||||
LEFT).
|
output folder.
|
||||||
`SKRIBIT_TAB_SITENAME` Tab identifier (See Skribit part below).
|
`STATIC_THEME_PATHS` (``['static']``) Static theme paths you want to copy. Default
|
||||||
`SKRIBIT_WIDGET_ID` Widget identifier (See Skribit part below).
|
values is `static`, but if your theme have
|
||||||
`STATIC_PATHS` The static paths you want to have accessible on the
|
others static paths, you can put them here.
|
||||||
output path "static". By default, pelican will copy
|
`TAG_CLOUD_STEPS` (4) Count of different font sizes in the tag
|
||||||
the 'images' folder to the output folder.
|
cloud.
|
||||||
`STATIC_THEME_PATHS` Static theme paths you want to copy. Default values
|
`TAG_CLOUD_MAX_ITEMS` (100) Maximum tags count in the cloud.
|
||||||
is `static`, but if your theme have others static paths,
|
`THEME` theme to use to product the output. can be the
|
||||||
you can put them here.
|
complete static path to a theme folder, or
|
||||||
`TAG_CLOUD_STEPS` Count of different font sizes in the tag cloud.
|
chosen between the list of default themes (see
|
||||||
`TAG_CLOUD_MAX_ITEMS` Maximum tags count in the cloud.
|
below)
|
||||||
`THEME` theme to use to product the output. can be the
|
`TRANSLATION_FEED` ('feeds/all-%s.atom.xml'[3]_) Where to put the RSS feed for translations.
|
||||||
complete static path to a theme folder, or chosen
|
`WITH_PAGINATION` (``False``) Activate pagination.
|
||||||
between the list of default themes (see below)
|
================================================ =====================================================
|
||||||
`TRANSLATION_FEED` Where to put the RSS feed for translations. Default
|
|
||||||
is feeds/all-%s.atom.xml where %s is the name of the
|
.. [1] %s is the name of the category.
|
||||||
lang.
|
|
||||||
`WITH_PAGINATION` Activate pagination. Default is False.
|
.. [2] Default is the system locale. Default is to delete the output directory.
|
||||||
======================== =======================================================
|
|
||||||
|
.. [3] %s is the language
|
||||||
|
|
||||||
Skribit
|
Skribit
|
||||||
=======
|
=======
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue