MyST Parser

MyST-パーサー

MyST は、技術文書と出版を目的とした、豊富で拡張可能な Markdown のフレーバーです。

MyST は、シンプルさ、柔軟性、拡張性を目的に設計されたマークダウンのフレーバーです。このリポジトリは、MyST Markdown のリファレンス実装として機能するだけでなく、Python および Sphinx での MyST の操作をサポートするツールのコレクションとしても機能します。これには、 markdown-it-pyを使用した拡張 CommonMark 準拠パーサーと、Sphinx で MyST Markdown を記述できるようにする Sphinx 拡張機能が含まれています。

詳細については、MyST パーサーのドキュメントを参照してください。

インストール

MyST パーサーをインストールするには、Conda 環境で次のコマンドを実行します (推奨)。

conda install -c conda-forge myst-parser

または

pip install myst-parser

またはパッケージ開発の場合:

git clone https://github.com/executablebooks/MyST-Parser
cd MyST-Parser
git checkout master
pip install -e .[code_style,linkify,testing,rtd]

Sphinx で MyST パーサーを使用するには、単にextensions = ["myst_parser"]をconf.pyに追加します。

貢献する

皆様のご投稿をお待ちしております。詳細については、「貢献ガイド」を参照してください。