Sobre MkDocs

Para acessar a documentação completa, visite mkdocs.org.

Comandos

• mkdocs new [dir-name] - Cria um novo projeto.
• mkdocs serve - Inicia o servidor de documentação em tempo real.
• mkdocs build - Constrói o site de documentação.
• mkdocs -h - Exibe a mensagem de ajuda e sai.

Organização do projeto

mkdocs.yml    # O arquivo de configuração.
docs/
    index.md  # A página inicial da documentação.
    ...       # Outras páginas em markdown, imagens e outros arquivos.