Bem-vindo ao MkDocs¶
Para obter a documentação completa, visite mkdocs.org.
Comandos¶
mkdocs new [nome-do-diretório]
- Cria um novo projeto.mkdocs serve
- Inicia o servidor live-reloading de docs.mkdocs build
- Construi o site de documentação.mkdocs -h
- Imprime mensagem de ajuda e sai.mkdocs gh-deploy
- Implanta o site nas páginas do github
Layout do projeto¶
mkdocs.yml # O arquivo de configuração.
docs/
index.md # A página inicial da documentação.
... # Outras páginas de markdown, imagens e outros arquivos.