MyST Parser

Analisador MyST

MyST é uma versão rica e extensível do Markdown destinada à documentação técnica e publicação .

MyST é uma versão de markdown projetada para simplicidade, flexibilidade e extensibilidade. Este repositório serve como implementação de referência do MyST Markdown, bem como uma coleção de ferramentas para apoiar o trabalho com MyST em Python e Sphinx. Ele contém um analisador estendido compatível com CommonMark usando markdown-it-py , bem como uma extensão Sphinx que permite escrever MyST Markdown no Sphinx.

Consulte a documentação do MyST Parser para obter mais informações .

Instalação

Para instalar o analisador MyST, execute o seguinte em um ambiente Conda (recomendado):

conda install -c conda-forge myst-parser

ou

pip install myst-parser

Ou para desenvolvimento de pacotes:

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

Para usar o analisador MyST no Sphinx, basta adicionar: extensions = ["myst_parser"] ao seu conf.py .

Contribuindo

Aceitamos todas as contribuições! Consulte o Guia de Contribuição para obter mais detalhes.