Exemplos de Uso do MKDocs

Sobre

Essa pagina está com o link da documentação do MKdocs e com os comandos para criar um examplo simples de uso.

Comandos

• mkdocs new [dir-name] - Criar um novo projeto.
• mkdocs serve - Iniciar o servidor com reiniciação viva.
• mkdocs build - Buildar a documentação em um site
• mkdocs -h - Imprimir na tela as mensagens de ajuda e saida.

Estrutura do Projeto

mkdocs.yml    # Arquivo de Configuração das páginas.
docs/
    index.md  # Pagina Principal da documentação.
    ...       # Outras paginas de marcação, imagens e outros arquivos.