diff --git a/docs/content.rst b/docs/content.rst index 6affecce..28ef1cbd 100644 --- a/docs/content.rst +++ b/docs/content.rst @@ -48,9 +48,9 @@ Pelican implements an extension to reStructuredText to enable support for the This will be turned into :abbr:`HTML (HyperText Markup Language)`. -You can also use Markdown syntax (with a file ending in ``.md``, -``.markdown``, ``.mkd``, or ``.mdown``). Markdown generation requires that you -first explicitly install the ``Markdown`` package, which can be done via ``pip +You can also use Markdown syntax (with a file ending in ``.md``, ``.markdown``, +``.mkd``, or ``.mdown``). Markdown generation requires that you first +explicitly install the Python-Markdown_ package, which can be done via ``pip install Markdown``. Pelican also supports `Markdown Extensions`_, which might have to be installed @@ -617,6 +617,7 @@ metadata to include ``Status: published``. .. _W3C ISO 8601: https://www.w3.org/TR/NOTE-datetime .. _AsciiDoc: https://www.methods.co.nz/asciidoc/ .. _pelican-plugins: https://github.com/getpelican/pelican-plugins +.. _Python-Markdown: https://github.com/Python-Markdown/markdown .. _Markdown Extensions: https://python-markdown.github.io/extensions/ .. _CodeHilite extension: https://python-markdown.github.io/extensions/code_hilite/#syntax .. _i18n_subsites plugin: https://github.com/getpelican/pelican-plugins/tree/master/i18n_subsites diff --git a/docs/faq.rst b/docs/faq.rst index bfe51ec0..c35cd6c6 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -273,3 +273,19 @@ as articles or pages before they get treated as static files. To circumvent this issue either use the appropriate ``*_EXCLUDES`` setting or disable the offending reader via ``READERS`` if you don't need it. + +Why is [arbitrary Markdown syntax] not supported? +================================================= + +Pelican does not directly handle Markdown processing and instead delegates that +task to the Python-Markdown_ project, the core of which purposefully follows +the original Markdown syntax rules and not the myriad Markdown "flavors" that +have subsequently propagated. That said, Python-Markdown_ is quite modular, and +the syntax you are looking for may be provided by one of the many available +`Markdown Extensions`_. Alternatively, some folks have created Pelican plugins +that support Markdown variants, so that may be your best choice if there is a +particular variant you want to use when writing your content. + + +.. _Python-Markdown: https://github.com/Python-Markdown/markdown +.. _Markdown Extensions: https://python-markdown.github.io/extensions/