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 MyST-Parser. MyST-Parser is a Docutils bridge to markdown-it-py, a Python package for parsing the CommonMark Markdown flavor.

設定

SphinxプロジェクトをMarkdownサポート用に設定するには、次の手順に従います。

  1. Install the Markdown parser MyST-Parser:

    pip install --upgrade myst-parser
    
  2. Add myst_parser to the list of configured extensions:

    extensions = ['myst_parser']
    

    注釈

    MyST-Parser requires Sphinx 2.1 or newer.

  3. .md 以外の拡張子を持つMarkdownファイルを使用する場合、 source_suffix 変数を調整してください。次の例では、Sphinxが拡張子 .md.txt を持つすべてのファイルをMarkdownとして解析するように設定しています:

    source_suffix = {
        '.rst': 'restructuredtext',
        '.txt': 'markdown',
        '.md': 'markdown',
    }
    
  4. You can further configure MyST-Parser to allow custom syntax that standard CommonMark doesn't support. Read more in the MyST-Parser documentation.