Skip to content

Bem-vindo ao Mkdocs

Documentação completa no site: mkdocs.org.

Siglas e conceitos

  • pleito - Criar um novo projeto.
  • pleito arquivado - Criar um novo projeto.
  • pleito aprovado - Criar um novo projeto.
  • mkdocs -h - Mensagem de ajuda e saída.

Comandos

  • mkdocs new [dir-name] - Criar um novo projeto.
  • mkdocs serve - Iniciar um servidor local.
  • mkdocs build - Criar a documentação do site(build).
  • mkdocs -h - Mensagem de ajuda e saída.

Layout do Projeto

mkdocs.yml    # Arquivo de configuração.
docs/
    index.md  # Pagina inicial da documentação.
    ...       # Outras páginas de markdown, imagens e outros arquivos.

Documentacao Mkdocs Material

A documentação está disponível abaixo:

Documentação Mkdocs