menu

MkDocs

O MkDocs é um gerador de site estático desenvolvido em Python e projetado para criar sites de documentação usando o Markdown.

Janela do Aplicativo MkDocs!

Visão geral

Escrito na linguagem de programação Python, o MkDocs é um projeto de código aberto com uma comunidade online enorme. Possui grande variedade de temas disponíveis. Em termos de compatibilidade com o Markdown, o MkDocs faz um excelente trabalho no suporte aos elementos básicos da sintaxe, mas falta suporte para alguns elementos da sintaxe estendida.

O aplicativo usa o processador do Markdown Python-Markdown e também permite que você ative extensões adicionais.

Site: https://www.mkdocs.org/

Suporte do Markdown no MkDocs

O MkDocs fornece suporte para os seguintes elementos Markdown.

Elemento Suporte Obs
Títulos Sim
Parágrafos Sim
Quebras de linha Sim
Negrito Sim
Itálico Sim
Bloco de citação 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 O realce da sintaxe também é suportado.
Notas de rodapé Não
Id de títulos Não
Listas de definições Não
Riscado Não
Listas de tarefas Não
Emoji (copiar e colar) Sim Você pode ativar uma extensão para usar esse elemento.
Emoji (códigos de acesso) Sim Você pode ativar uma extensão para usar esse elemento.
Link automático de URL Sim
Desativar o link automático de URL Sim
HTML Sim
Usando Admonitions no MkDocs

Aqui vai uma dica valiosa: você pode ativar uma extensão para começar a usar Admonitions (advertências) no MkDocs. É uma maneira rápida e fácil de implementar notas, avisos e dicas no seu site criado com a ferramenta. Veja este issue no GitHub para mais informações e exemplos.

Veja também

Escrevendo em Markdown no MkDocs

Repositório do MkDocs no GitHub