Website portado para Mkdocs

[herzenschein]

Isso aqui porta o conteúdo do repositório para Mkdocs.

Mkdocs é legal porque ele permite que você escreva em Markdown e tem um tema padrão do WriteTheDocs (chamado readthedocs).

Daí dá para usar o Github Pages para disponibilizar o site online.

Naturalmente precisaria dar uma melhorada no README.md para linkar propriamente para o site gerado, adicionar um Github Action para gerar o Github Pages, e usar mkdocs build para gerar a pasta site/ que é onde ficaria o conteúdo para publicar online. Só por isso tá como draft (isso e tbm pq seria melhor fazer merge dos outros PRs antes).

O resultado:

Já que o tema do WriteTheDocs não tem toggle de modo dark, e o tema padrão do mkdocs é meio feio, dá pra usar o mkdocs-material por exemplo com algumas poucas alterações. Fica assim:

[patrickelectric]

Pessoalmente, tenho mixed feelings, não sei se seria o melhor formato do material, talvez algum template mais amplo, sem os menus, seria melhor, como temos na pagina de README, mas a pagina de README ja faz um ótimo trabalho. Novamente, mixed feelings.

[herzenschein]

talvez algum template mais amplo, sem os menus, seria melhor, como temos na pagina de README

Bem, a razão de eu ter feito isso é para ter os menus e páginas separadas. O readme é tão longo que fica difícil de localizar o conteúdo, a maioria das alterações toca o mesmo arquivo, e do jeito atual não tem índice ou pesquisa e os livros pagos e exercícios tem pouca visibilidade.

No mkdocs-material inclusive tem uma configuração para manter os submenus da barra lateral sempre abertos, assim todo o conteúdo fica skimmable e a um clique de distância.