Markdown¶

Markdown é uma linguagem de marcação leve com uma sintaxe simplista de formatação de texto simples. Existe em muitos sabores sintaticamente diferentes. Para oferecer suporte a documentação baseada em Markdown, o Sphinx pode usar MyST-Parser. O MyST-Parser é uma ponte com Docutils para markdown-it-py, um pacote Python para analisar o sabor Markdown CommonMark.

Configuração¶

Para configurar um projeto Sphinx para ter suporte a Markdown, faça o seguinte:

Instale o analisador Markdown MyST-Parser:
```
pip install --upgrade myst-parser
```
Adicione myst_parser à lista de extensões configuradas:
```
extensions = ['myst_parser']
```
Nota

MyST-Parser requer Sphinx 2.1 ou mais recente.
Se você quiser usar arquivos Markdown com extensões diferentes de .md, ajuste a variável source_suffix. O exemplo a seguir configura o Sphinx para analisar todos os arquivos com as extensões .md e .txt como Markdown:
```
source_suffix = {
    '.rst': 'restructuredtext',
    '.txt': 'markdown',
    '.md': 'markdown',
}
```
Você pode configurar ainda mais o MyST-Parser para permitir sintaxe personalizada que o CommonMark padrão não oferece suporte. Leia mais na documentação do MyST-Parser.