減記する.

Markdown __は軽量マークアップ言語であり、簡単な平文フォーマット文法を有する。多くの構文の異なる場所に存在しています 香料. それがそうです。Markdownに基づく文書をサポートするためには、Sphinxが利用できます `recommonmark`_ _。RECONOMARKはDocutilsに通じています `CommonMark-py`_ _、これは解析のためのPythonパッケージです `CommonMark`_ _値下げ味。

配置

値下げサポートを得るためにSphinxプロジェクトを構成するには、以下の手順で操作してください。

  1. Markdown解析器の設置 再マークする **

    pip install --upgrade recommonmark
    

    注釈

    ここで説明した構成は、バージョン0.5.0以上を再マークする必要がある。

  2. 増列する. 再マークする 致す list of configured extensions **

    extensions = ['recommonmark']
    

    バージョン 1.8 で変更: バージョン1.8は破棄され、バージョン3.0は削除されました source_parsers 旧バージョンで使用されている構成変数 再マークする バージョンです。

  3. 拡張名ではないMarkdown文書を使うには .md 調整して source_suffix 変数です。以下の例では、Sphinxを拡張子が持つすべてのファイルを解析するように構成します。 .md そして .txt 値下げとして:

    source_suffix = {
        '.rst': 'restructuredtext',
        '.txt': 'markdown',
        '.md': 'markdown',
    }
    
  4. さらに構成することができます 再マークする 自定義文法の基準を許す CommonMark 支持しません。どうぞ `recommonmark documentation`_ _.