MkDocs
O MkDocs é uma ferramenta desenvolvida em Python para gerar sites estáticos de documentação usando como base arquivos Markdown.
Visão geral
O MkDocs é uma ferramenta bem popular com uma comunidade enorme. Possui diversos temas para a criação de sites; vários plugins para estender a funcionalidade básica do programa e uma documentação fácil de entender.
O MkDocs é um projeto de código fonte aberto desenvolvido em Python.
O Aplicativo usa o processador Markdown Python-Markdown fornecendo um suporte muito bom aos elementos básicos da sintaxe, porém, a compatibilidade com os elementos da sintaxe estendida, deixa um pouco a desejar.
Vale notar que, como o MkDocs usa o Python-Markdown, é possível ativar extensões adicionais para alterar o comportamento do parser, clique aqui para visualizar uma lista de extensões disponíveis e compatíveis com o Python-Markdown.
Você pode encontrar mais informações no site oficial do MkDocs https://www.mkdocs.org/.
Usando Admonitions no MkDocs
A extensão Admonitions permite que você mostre para os usuários mensagens estilizadas na sua página em sites criados com o MkDocs.
Para mais informações e exemplos, consulte essa página no GitHub.
Suporte ao Markdown no MkDocs
A Tabela 1.1 apresenta os elementos Markdown compatíveis com o MkDocs.
| Elemento | Suporte | Informação |
|---|---|---|
| Títulos | Sim | |
| Parágrafos | Sim | |
| Quebras de linha | Sim | |
| Negrito | Sim | |
| Itálico | Sim | |
| Blockquote | Sim | |
| Listas ordenadas | Sim | |
| Listas não ordenadas | Sim | |
| Código | Sim | |
| Linhas horizontais | Sim | |
| Links | Sim | |
| Imagens | Sim | |
| Tabelas | Sim | |
| Blocos de código cercado | Sim | É possível destacar a sintaxe do conteúdo do bloco. |
| Notas de rodapé | Não | |
| Id de títulos | Não | |
| Listas de definições | Não | |
| Tachado | Não | |
| Listas de tarefas | Não | |
| Emoji (copiar e colar) | Sim | Não há suporte por padrão, mas você pode ativar uma extensão para usar esse elemento Markdown. |
| Emoji (códigos de acesso) | Sim | O MkDocs não é compatível com os códigos de emoticons por padrão, mas você pode instalar uma extensão para formatar conteúdo usando esse elemento Markdown. |
| Link automático de URL | Sim | |
| Desativar o link automático de URL | Sim | |
| HTML | Sim |