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

fix documentation

Browse source
This commit is contained in:
Alexis Metaireau 2011-02-01 02:06:54 +00:00
commit cd9f672662
1 changed files with 54 additions and 52 deletions
Download patch file Download diff file Expand all files Collapse all files

106
docs/settings.rst
View file

@ -19,58 +19,60 @@ processed.
Here are the available settings. Please note that all the settings you put in 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 what it does ?
`AUTHOR` Default author (put your name) ======================== =======================================================
`CATEGORY_FEED` Where to put the atom categories feeds. default is `AUTHOR` Default author (put your name)
`feeds/%s.atom.xml`, where %s is the name of the `CATEGORY_FEED` Where to put the atom categories feeds. default is
category. `feeds/%s.atom.xml`, where %s is the name of the
`CATEGORY_FEED_RSS` Where to put the categories rss feeds. default is None category.
(no rss) `CATEGORY_FEED_RSS` Where to put the categories rss feeds. default is None
`CSS_FILE` To specify the CSS file you want to load, if it's not (no rss)
the default one ('main.css') `CSS_FILE` To specify the CSS file you want to load, if it's not
`DEFAULT_CATEGORY` The default category to fallback on. `misc` by default. the default one ('main.css')
`DEFAULT_LANG` The default language to use. Default is 'en'. `DEFAULT_CATEGORY` The default category to fallback on. `misc` by default.
`DISPLAY_PAGES_ON_MENU` Display or not the pages on the menu of the template. `DEFAULT_LANG` The default language to use. Default is 'en'.
Templates can follow or not this settings. `DISPLAY_PAGES_ON_MENU` Display or not the pages on the menu of the template.
`FALLBACK_ON_FS_DATE` If True, pelican will use the file system dates infos Templates can follow or not this settings.
(mtime) if it can't get informations from the `FALLBACK_ON_FS_DATE` If True, pelican will use the file system dates infos
metadata? (mtime) if it can't get informations from the
`FEED` relative url to output the atom feed. Default is metadata?
`feeds/all.atom.xml` `FEED` relative url to output the atom feed. Default is
`FEED_RSS` relative url to output the rss feed. Default is `feeds/all.atom.xml`
None (no rss) `FEED_RSS` relative url to output the rss feed. Default is
`JINJA_EXTENSIONS` A list of any Jinja2 extensions you want to use. None (no rss)
Default is no extensions (the empty list). `JINJA_EXTENSIONS` A list of any Jinja2 extensions you want to use.
`KEEP_OUTPUT_DIRECTORY` Keep the output directory and just update all the generated files. Default is no extensions (the empty list).
Default is to delete the output directory. `KEEP_OUTPUT_DIRECTORY` Keep the output directory and just update all the
`MARKUP` A list of available markup languages you want to use. generated files.
For the moment, only available values are `rst` and `md`. Default is to delete the output directory.
`OUTPUT_PATH` Where to output the generated files. Default to `MARKUP` A list of available markup languages you want to use.
"output" For the moment, only available values are `rst` and `md`.
`PATH` path to look at for input files. `OUTPUT_PATH` Where to output the generated files. Default to
`PDF_PROCESSOR` Put True if you want to have PDF versions of your "output"
documents. You will need to install `rst2pdf`. `PATH` path to look at for input files.
`REVERSE_ARCHIVE_ORDER` Reverse the archives order. (True makes it in `PDF_PROCESSOR` Put True if you want to have PDF versions of your
descending order: the newer first) documents. You will need to install `rst2pdf`.
`REVERSE_CATEGORY_ORDER` Reverse the category order. (True makes it in `REVERSE_ARCHIVE_ORDER` Reverse the archives order. (True makes it in
descending order, default is alphabetically) descending order: the newer first)
`SITEURL` base URL of your website. `REVERSE_CATEGORY_ORDER` Reverse the category order. (True makes it in
`SITENAME` Your site name, descending order, default is alphabetically)
`STATIC_PATHS` The static paths you want to have accessible on the `SITEURL` base URL of your website.
output path "static". By default, pelican will copy `SITENAME` Your site name,
the 'images' folder to the output folder. `STATIC_PATHS` The static paths you want to have accessible on the
`STATIC_THEME_PATHS` Static theme paths you want to copy. Default values output path "static". By default, pelican will copy
is `static`, but if your theme have others static paths, the 'images' folder to the output folder.
you can put them here. `STATIC_THEME_PATHS` Static theme paths you want to copy. Default values
`THEME` theme to use to product the output. can be the is `static`, but if your theme have others static paths,
complete static path to a theme folder, or chosen you can put them here.
between the list of default themes (see below) `THEME` theme to use to product the output. can be the
`TRANSLATION_FEED` Where to put the RSS feed for translations. Default complete static path to a theme folder, or chosen
is feeds/all-%s.atom.xml where %s is the name of the between the list of default themes (see below)
lang. `TRANSLATION_FEED` Where to put the RSS feed for translations. Default
======================= ======================================================= is feeds/all-%s.atom.xml where %s is the name of the
lang.
======================== =======================================================
Themes Themes
====== ======