MyST Parser

MonST-Parser

MyST est une version riche et extensible de Markdown destinée à la documentation technique et à la publication .

MyST est une version de démarque conçue pour la simplicité, la flexibilité et l'extensibilité. Ce référentiel sert d'implémentation de référence de MyST Markdown, ainsi que d'un ensemble d'outils permettant de prendre en charge l'utilisation de MyST en Python et Sphinx. Il contient un analyseur étendu compatible CommonMark utilisant markdown-it-py , ainsi qu'une extension Sphinx qui vous permet d'écrire MyST Markdown dans Sphinx.

Consultez la documentation de MyST Parser pour plus d'informations .

Installation

Pour installer l'analyseur MyST, exécutez ce qui suit dans un environnement Conda (recommandé) :

conda install -c conda-forge myst-parser

ou

pip install myst-parser

Ou pour le développement de packages :

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

Pour utiliser l'analyseur MyST dans Sphinx, ajoutez simplement : extensions = ["myst_parser"] à votre conf.py .

Contribuer

Nous apprécions toutes les contributions ! Consultez le Guide de contribution pour plus de détails.