MyST Parser

MyST-Парсер

MyST — это богатая и расширяемая версия Markdown, предназначенная для технической документации и публикаций .

MyST — это вариант уценки, разработанный для простоты, гибкости и расширяемости. Этот репозиторий служит эталонной реализацией MyST Markdown, а также набором инструментов для поддержки работы с MyST в Python и Sphinx. Он содержит расширенный синтаксический анализатор, совместимый с CommonMark, с использованием markdown-it-py , а также расширение Sphinx, которое позволяет писать MyST Markdown в Sphinx.

Дополнительную информацию смотрите в документации MyST Parser .

Установка

Чтобы установить парсер 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]

Чтобы использовать парсер MyST в Sphinx, просто добавьте: extensions = ["myst_parser"] в ваш conf.py

Содействие

Мы приветствуем все вклады! Дополнительную информацию см. в Руководстве для участников.