doc: updates MARKDOWN

This commit is contained in:
Bernhard Scheirle 2016-11-01 13:02:22 +01:00
commit 114e64dcf7
4 changed files with 12 additions and 9 deletions

1
THANKS
View file

@ -26,6 +26,7 @@ asselinpaul
Axel Haustant
Ben Rosser (TC01)
Benoît HERVIER
Bernhard Scheirle
Borgar
Brandon W Maister
Brendan Wholihan

View file

@ -15,6 +15,7 @@ Next release
* Author slugs can be controlled with greater precision using the
``AUTHOR_SUBSTITUTIONS`` setting. Keeping non-alphanum characters is supported
as well but discouraged.
* Replaced ``MD_EXTENSIONS`` with ``MARKDOWN``
3.6.3 (2015-08-14)
==================

View file

@ -55,7 +55,7 @@ install Markdown``.
Pelican also supports `Markdown Extensions`_, which might have to be installed
separately if they are not included in the default ``Markdown`` package and can
be configured and loaded via the ``MD_EXTENSIONS`` setting.
be configured and loaded via the ``MARKDOWN`` setting.
Metadata syntax for Markdown posts should follow this pattern::

View file

@ -114,15 +114,16 @@ Setting name (followed by default value, if any)
of these patterns will be ignored by the processor. For example,
the default ``['.#*']`` will ignore emacs lock files, and
``['__pycache__']`` would ignore Python 3's bytecode caches.
``MD_EXTENSIONS =`` ``{...}`` A dict of the extensions that the Markdown processor
will use, with extensions' settings as the values.
``MARKDOWN =`` ``{...}`` Extra configuration settings for the Markdown processor.
Refer to the Python Markdown documentation's
`Extensions section <http://pythonhosted.org/Markdown/extensions/>`_
for a complete list of supported extensions and their options.
Default is ``{'markdown.extensions.codehilite' : {'css_class': 'highlight'},
'markdown.extensions.extra': {}, 'markdown.extensions.meta': {}}``.
(Note that the dictionary defined in your settings file will
update this default one.)
`Options section
<http://pythonhosted.org/Markdown/reference.html#markdown>`_
for a complete list of supported options.
The ``extensions`` option will be automatically computed from the
``extension_configs`` option.
Default is ``'extension_configs': {'markdown.extensions.codehilite':
{'css_class': 'highlight'},'markdown.extensions.extra': {},
'markdown.extensions.meta': {},},``.
``OUTPUT_PATH = 'output/'`` Where to output the generated files.
``PATH`` Path to content directory to be processed by Pelican. If undefined,
and content path is not specified via an argument to the ``pelican``