mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
48 lines
1.4 KiB
ReStructuredText
48 lines
1.4 KiB
ReStructuredText
.. highlight:: python
|
|
|
|
.. _markdown:
|
|
|
|
========
|
|
Markdown
|
|
========
|
|
|
|
`Markdown`__ is a lightweight markup language with a simplistic plain text
|
|
formatting syntax. It exists in many syntactically different *flavors*. To
|
|
support Markdown-based documentation, Sphinx can use `recommonmark`__.
|
|
recommonmark is a Docutils bridge to `CommonMark-py`__, a Python package for
|
|
parsing the `CommonMark`__ Markdown flavor.
|
|
|
|
__ https://daringfireball.net/projects/markdown/
|
|
__ https://recommonmark.readthedocs.io/en/latest/index.html
|
|
__ https://github.com/rtfd/CommonMark-py
|
|
__ https://commonmark.org/
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
To configure your Sphinx project for Markdown support, proceed as follows:
|
|
|
|
#. Install *recommonmark*::
|
|
|
|
pip install recommonmark
|
|
|
|
#. Add the Markdown parser to the ``source_parsers`` configuration variable in
|
|
your Sphinx configuration file::
|
|
|
|
source_parsers = {
|
|
'.md': 'recommonmark.parser.CommonMarkParser',
|
|
}
|
|
|
|
You can replace ``.md`` with a filename extension of your choice.
|
|
|
|
#. Add the Markdown filename extension to the ``source_suffix`` configuration
|
|
variable::
|
|
|
|
source_suffix = ['.rst', '.md']
|
|
|
|
#. You can further configure *recommonmark* to allow custom syntax that
|
|
standard *CommonMark* doesn't support. Read more in the `recommonmark
|
|
documentation`__.
|
|
|
|
__ https://recommonmark.readthedocs.io/en/latest/auto_structify.html
|