summaryrefslogtreecommitdiffstats
path: root/nikola/conf.py.in
diff options
context:
space:
mode:
Diffstat (limited to 'nikola/conf.py.in')
-rw-r--r--nikola/conf.py.in78
1 files changed, 64 insertions, 14 deletions
diff --git a/nikola/conf.py.in b/nikola/conf.py.in
index 20605d8..6ae0e1d 100644
--- a/nikola/conf.py.in
+++ b/nikola/conf.py.in
@@ -25,28 +25,33 @@ BLOG_DESCRIPTION = "${BLOG_DESCRIPTION}"
# Currently supported languages are:
# bg Bulgarian
# ca Catalan
+# cs Czech [ALTERNATIVELY cz]
# de German
# el Greek [NOT gr!]
# en English
# eo Esperanto
# es Spanish
+# et Estonian
+# eu Basque
# fa Persian
# fi Finnish
# fr French
# hr Croatian
# it Italian
-# jp Japanese
+# ja Japanese [NOT jp!]
+# nb Norwegian Bokmål
# nl Dutch
# pt_br Portuguese (Brasil)
# pl Polish
# ru Russian
# sl Slovenian [NOT sl_si!]
-# tr_tr Turkish (Turkey)
+# tr Turkish (Turkey) [NOT tr_tr!]
+# ur Urdu
# zh_cn Chinese (Simplified)
#
# If you want to use Nikola with a non-supported language you have to provide
# a module containing the necessary translations
-# (p.e. look at the modules at: ./nikola/data/themes/default/messages/fr.py).
+# (cf. the modules at nikola/data/themes/base/messages/fr.py).
# If a specific post is not translated to a language, then the version
# in the default language will be shown instead.
@@ -62,6 +67,20 @@ TRANSLATIONS = {
# "es": "./es",
}
+# What will translated input files be named like?
+
+# If you have a page something.rst, then something.rst.pl will be considered
+# its Polish translation.
+# (in the above example: path == "something", lang == "pl", ext == "rst")
+# this pattern is also used for metadata:
+# something.meta -> something.meta.pl
+
+TRANSLATIONS_PATTERN = "{path}.{ext}.{lang}"
+
+# If you don't want your Polish files to be considered Perl code, use this:
+# TRANSLATIONS_PATTERN = "{path}.{lang}.{ext}"
+# Note that this pattern will become the default in v7.0.0.
+
# Links for the sidebar / navigation bar.
# You should provide a key-value pair for each used language.
NAVIGATION_LINKS = {
@@ -96,6 +115,8 @@ NAVIGATION_LINKS = {
# and optionally translated files (example for spanish, with code "es"):
# whatever/thing.txt.es and whatever/thing.meta.es
#
+# This assumes you use the default TRANSLATIONS_PATTERN.
+#
# From those files, a set of HTML fragment files will be generated:
# cache/whatever/thing.html (and maybe cache/whatever/thing.html.es)
#
@@ -165,6 +186,12 @@ COMPILERS = ${COMPILERS}
# ARCHIVE_PATH = ""
# ARCHIVE_FILENAME = "archive.html"
+# URLs to other posts/pages can take 3 forms:
+# rel_path: a relative URL to the current page/post (default)
+# full_path: a URL with the full path from the root
+# absolute: a complete URL (that includes the SITE_URL)
+# URL_TYPE = 'rel_path'
+
# Final locations are:
# output / TRANSLATION[lang] / RSS_PATH / rss.xml
# RSS_PATH = ""
@@ -187,7 +214,7 @@ COMPILERS = ${COMPILERS}
# Commands to execute to deploy. Can be anything, for example,
# you may use rsync:
-# "rsync -rav output/* joe@my.site:/srv/www/site"
+# "rsync -rav --delete output/ joe@my.site:/srv/www/site"
# And then do a backup, or run `nikola ping` from the `ping`
# plugin (`nikola install_plugin ping`).
# To do manual deployment, set it to []
@@ -235,11 +262,17 @@ COMPILERS = ${COMPILERS}
# Use an external gzip command? None means no.
# Example: GZIP_COMMAND = "pigz -k {filename}"
# GZIP_COMMAND = None
-# Make sure the server does not return a "Accept-Ranges: bytes" header for
+# Make sure the server does not return a "Accept-Ranges: bytes" header for
# files compressed by this option! OR make sure that a ranged request does not
# return partial content of another representation for these resources. Do not
# use this feature if you do not understand what this means.
+# Compiler to process LESS files.
+# LESS_COMPILER = 'lessc'
+
+# Compiler to process Sass files.
+# SASS_COMPILER = 'sass'
+
# #############################################################################
# Image Gallery Options
# #############################################################################
@@ -259,10 +292,13 @@ COMPILERS = ${COMPILERS}
# HTML fragments and diverse things that are used by the templates
# #############################################################################
-# Data about post-per-page indexes
-# INDEXES_TITLE = "" # If this is empty, the default is BLOG_TITLE
-# INDEXES_PAGES = "" # If this is empty, the default is 'old posts page %d'
-# translated
+# Data about post-per-page indexes.
+# INDEXES_PAGES defaults to 'old posts, page %d' or 'page %d' (translated),
+# depending on the value of INDEXES_PAGES_MAIN.
+# INDEXES_TITLE = "" # If this is empty, defaults to BLOG_TITLE
+# INDEXES_PAGES = "" # If this is empty, defaults to '[old posts,] page %d' (see above)
+# INDEXES_PAGES_MAIN = False # If True, INDEXES_PAGES is also displayed on
+ # the main (the newest) index page (index.html)
# Name of the theme to use.
THEME = "${THEME}"
@@ -330,7 +366,7 @@ CONTENT_FOOTER = CONTENT_FOOTER.format(email=BLOG_EMAIL,
# To use comments, you can choose between different third party comment
# systems, one of "disqus", "livefyre", "intensedebate", "moot",
-# "googleplus" or "facebook"
+# "googleplus", "facebook" or "isso"
# COMMENT_SYSTEM = "disqus"
# And you also need to add your COMMENT_SYSTEM_ID which
# depends on what comment system you use. The default is
@@ -583,14 +619,15 @@ CONTENT_FOOTER = CONTENT_FOOTER.format(email=BLOG_EMAIL,
# }
-# Post's dates are considered in GMT by default, if you want to use
-# another timezone, please set TIMEZONE to match. Check the available
+# Post's dates are considered in UTC by default, if you want to use
+# another time zone, please set TIMEZONE to match. Check the available
# list from Wikipedia:
# http://en.wikipedia.org/wiki/List_of_tz_database_time_zones
-# Also, if you want to use a different timezone in some of your posts,
+# (eg. 'Europe/Zurich')
+# Also, if you want to use a different time zone in some of your posts,
# you can use W3C-DTF Format (ex. 2012-03-30T23:00:00+02:00)
#
-# TIMEZONE = 'Europe/Zurich'
+# TIMEZONE = 'UTC'
# If webassets is installed, bundle JS and CSS to make site loading faster
# USE_BUNDLES = True
@@ -598,6 +635,11 @@ CONTENT_FOOTER = CONTENT_FOOTER.format(email=BLOG_EMAIL,
# Plugins you don't want to use. Be careful :-)
# DISABLED_PLUGINS = ["render_galleries"]
+# Add the absolute paths to directories containing plugins to use them.
+# For example, the `plugins` directory of your clone of the Nikola plugins
+# repository.
+# EXTRA_PLUGINS_DIRS = []
+
# Experimental plugins - use at your own risk.
# They probably need some manual adjustments - please see their respective
# readme.
@@ -615,6 +657,14 @@ CONTENT_FOOTER = CONTENT_FOOTER.format(email=BLOG_EMAIL,
# If set to True, enable optional hyphenation in your posts (requires pyphen)
# HYPHENATE = False
+# The <hN> tags in HTML generated by certain compilers (reST/Markdown)
+# will be demoted by that much (1 → h1 will become h2 and so on)
+# This was a hidden feature of the Markdown and reST compilers in the
+# past. Useful especially if your post titles are in <h1> tags too, for
+# example.
+# (defaults to 1.)
+# DEMOTE_HEADERS = 1
+
# You can configure the logging handlers installed as plugins or change the
# log level of the default stdout handler.
LOGGING_HANDLERS = {