Template dos tutoriais

  1. Realizar um fork do repositório
  2. Clonar esse repositório
  3. Instalar dependências
  4. Editar arquivo docs-src/index.md
  5. Testar com mkdocs

Instalar dependências

O site da disciplina faz uso do mkdocs com o tema material, para instalar, execute no bash:

pip install -r requirements.txt
pip install mkdocs-minify-plugin>=0.2

Exemplo

O arquivo docs-src/index.md possui exemplos de estruturas que podem ser utilizadas no tutorial, mais podem ser encontradas em:

Para visualizar o exemplo, acesse:

Testando

Para testar abra o terminal na raiz desse repositório e digite:

mkdocs serve

Agora você pode acessar a página: https://localhost:8000 para verificar o resultado.

Deploy github