Pular para conteúdo

O projeto de documentação do SigEscola

A documentação do SigEscola é gerada pelo MkDocs.

Comandos

  • mkdocs serve - Inicia o servidor de desenvolvimento e abre o navegador.
  • mkdocs build - Constrói o site estático.
  • mkdocs -h - Mostra a ajuda do MkDocs.

Estrutura do projeto

mkdocs.yml    # O arquivo de configuração do MkDocs.
docs/
    index.md  # O arquivo de entrada da documentação.
    ...       # Outros arquivos de documentação.

Tema da Documentação

O tema da documentação é o Material for MkDocs.