IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

document markdown support: work in review comments #2303 #825

Browse Source
This commit is contained in:
Timotheus Kampik 2017-02-01 19:16:05 +01:00 committed by Takeshi KOMIYA
parent 82d608ccaf
commit 681139ee0f
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/markdown.rst
View File

@ -8,21 +8,22 @@ Markdown support
`Markdown <https://daringfireball.net/projects/markdown/>`__ is a lightweight markup language with a simplistic plain `Markdown <https://daringfireball.net/projects/markdown/>`__ is a lightweight markup language with a simplistic plain
text formatting syntax. text formatting syntax.
It exists in many syntactically different *flavors*. It exists in many syntactically different *flavors*.
To support Markdown-based documentation, Sphinx can use `CommonMark-py <https://github.com/rtfd/CommonMark-py>`__, a To support Markdown-based documentation, Sphinx can use
Python package for parsing the `CommonMark <http://commonmark.org/>`__ flavor. In addition, Sphinx uses `recommonmark <http://recommonmark.readthedocs.io/en/latest/index.html>`__.
`recommonmark <http://recommonmark.readthedocs.io/en/latest/index.html>`__, a Docutils bridge to CommonMark. recommonmark is a Docutils bridge to `CommonMark-py <https://github.com/rtfd/CommonMark-py>`__, a
Python package for parsing the `CommonMark <http://commonmark.org/>`__ Markdown flavor.
Configuration Configuration
------------- -------------
To configure your Sphinx project for markdown support, proceed as follows: To configure your Sphinx project for Markdown support, proceed as follows:
#. Install CommonMark version **0.5.4** and recommonmark: #. Install recommonmark:
:: ::
pip install commonmark==0.5.4 recommonmark pip install recommonmark
#. Add the Markdown parser to the ``source_parsers`` configuration variable in your Sphinx configuration file: #. Add the Markdown parser to the ``source_parsers`` configuration variable in your Sphinx configuration file: