MyST Parser

MyST-Parser

MyST ist eine reichhaltige und erweiterbare Variante von Markdown für die technische Dokumentation und Veröffentlichung .

MyST ist eine Markdown-Variante, die auf Einfachheit, Flexibilität und Erweiterbarkeit ausgelegt ist. Dieses Repository dient als Referenzimplementierung von MyST Markdown sowie als Sammlung von Tools zur Unterstützung der Arbeit mit MyST in Python und Sphinx. Es enthält einen erweiterten CommonMark-kompatiblen Parser, der markdown-it-py verwendet, sowie eine Sphinx-Erweiterung, die es Ihnen ermöglicht, MyST Markdown in Sphinx zu schreiben.

Weitere Informationen finden Sie in der MyST-Parser-Dokumentation .

Installation

Um den MyST-Parser zu installieren, führen Sie Folgendes in einer Conda-Umgebung aus (empfohlen):

conda install -c conda-forge myst-parser

oder

pip install myst-parser

Oder für die Paketentwicklung:

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

Um den MyST-Parser in Sphinx zu verwenden, fügen Sie einfach: extensions = ["myst_parser"] zu Ihrer conf.py hinzu.

Mitwirken

Wir freuen uns über alle Beiträge! Weitere Einzelheiten finden Sie im Beitragsleitfaden.