Get Start

O objetivo deste projeto é criar uma documentação técnica, de fácil acesso e edição para devs.

Documentação completa publicada no Github.

Alna Docs

Toda a documentação é feita utilizando a ferramente MkDocs e Material. Para mais detalhes visite:

• MkDocs: mkdocs.org.
• Material: squidfunk.github.io

Passos Para Criar e Vizualizar a Documentação.

• Instale o MkDocs com o comando: pip install mkdocs
• Crie um projeto (caso ainda não exista) com o comando: mkdocs new nome-do-projeto.
• No diretório raiz do projeto, compile o projeto com o comando: mkdocs build.
• No diretório raiz do projeto, publique o projeto com o comando: mkdocs serve.
• Acesse a página http://127.0.0.1:8000/.

mkdocs serve -a localhost:7101

Compilar e Publicar Documetação

• mkdocs build - Empacota a documentação no diretório site para publicação.
• mkdocs serve - Inicia o servidor de documentação com live-loading.
• mkdocs help - Imprime ajuda.

Layout do Projeto

mkdocs.yml    # Arquivo de configuração.
docs/
    index.md  # Documento principal (home).
    ...       # Outras páginas markdown, imagens e outros arquivos.

Material Para MkDocs

O tema Material é um estilo de cores e fontes para o MkDocs. Para mais informações acesse o site mkdocs-material.

Documentação completa para iniciar: Começando

Vídeo com o passo-a-passo: Material para MkDocs com James Willett.

Guia de referência: Material for MkDocs.

Adicionar Tema Material

Para adicionar o tema Material use o seguinte comando: pip install mkdocs-material.

Agora, no arquivo mkdocs.yml adicione o atributo theme, conforme exemplo abaixo:

    site_name: Alna

    theme:
      name: material

    nav:
      - Início: index.md
      - Menu-01: 'menu-01/tools-and-configs.md'
      - Menu-02:
        - 'Submenu-02-1': 'menu-02/calendar.md'
        - 'Submenu-02-1': 'menu-02/course.md'
        - 'Submenu-02-1': 'menu-02/enrollment.md'