Skip to content

Commit 803d30c

Browse files
committed
Inclusion of MkDocs
1 parent 056ebb0 commit 803d30c

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

docs/mkdocs.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Bem-vindo ao MkDocs
2+
3+
Para obter a documentação completa, visite [mkdocs.org](https://www.mkdocs.org).
4+
5+
## Comandos
6+
7+
* `mkdocs new [nome-do-diretório]` - Cria um novo projeto.
8+
* `mkdocs serve` - Inicia o servidor _live-reloading_ de docs.
9+
* `mkdocs build` - Construi o site de documentação.
10+
* `mkdocs -h` - Imprime mensagem de ajuda e sai.
11+
* `mkdocs gh-deploy` - Implanta o site nas páginas do github
12+
13+
## Layout do projeto
14+
15+
mkdocs.yml # O arquivo de configuração.
16+
docs/
17+
index.md # A página inicial da documentação.
18+
... # Outras páginas de markdown, imagens e outros arquivos.

0 commit comments

Comments
 (0)