Um digital garden para documentação

Nota: Se você veio até aqui querendo o que interessa, vá na última linha do texto.

Bem, este é o primeiro post em português de fato. Anteriormente, só fiz o anúncio do que eu iria fazer e, no caso, estou fazendo. Vou falar um pouco sobre conhecimento adquirido e sobre como o armazeno.

Você sabe o que é um digital garden? Um digital garden é um espaço seu na internet, tipo um blog, mas que não é exatamente um blog, onde você “cultiva” ideias, notas, referências, imagens, vídeos e aprendizados ao longo do tempo. Diferente do blog, que costuma organizar textos prontos em ordem cronológica, o jardim, ou digital garden, aceita conteúdos incompletos, interligados por links e sempre sujeitos a revisões. Ele funciona como uma extensão pública do pensamento: algumas notas são apenas sementes, enquanto outras amadurecem conforme você pesquisa, aprende e estabelece novas conexões.

Pense em uma pasta do seu computador na qual você salva tudo de que gosta. Depois, transforme isso em um site que frequentemente recebe novas notas e outros conteúdos. Essa seria a explicação curta do que é um digital garden.

Eu precisava de algo assim. Faço muitas pesquisas e tenho fome de aprender mais, todos os dias. Mas estava cansado de pesquisar, às vezes, diversas vezes sobre os mesmos assuntos. Então iniciei um digital garden.

Queria colocar documentação, tutoriais, links e qualquer tranqueira que eu quisesse em algum lugar. Mas você pode perguntar: por que você não usou o Notion ou o Obsidian?

A resposta é simples: eu queria que fosse público e auto-hospedado.

Coisa que muitas ferramentas entregam apenas em parte.

Ter controle de todos os seus dados é extremamente importante, não apenas por questões de privacidade. Mas todos esses pontos serão abordados no futuro. Já foram abordados em inglês, então, caso queira ler sobre isso agora, procure no blog.

Uso o Obsidian de forma offline e, por meio dele, tomei nota de diversas coisas que eram importantes para mim. Até aí, eu já tinha meu conteúdo. Precisava torná-lo público.

Como o Obsidian utiliza escrita em Markdown, eu precisava apenas ajustar uma coisa ou outra, usar um SSG (Static Site Generator) e pronto: teria o site. Era só customizar, hospedar e pronto.

E, acredite, juntei muita coisa nos últimos dois anos da minha vida. Muito conhecimento. Eu quebrei minha própria Lei de Moore cerebral.

Eu disse “documentação” não apenas porque haverá docs nesse sistema, mas porque queria organizá-lo como os sites de documentação de verdade. Sabe quando você entra em algum site legal, clica em “Documentação” e encontra tudo organizadinho? Na maioria das vezes, são stacks prontas. A única coisa que fiz foi escolher uma e colocar tudo junto.

Eu havia escolhido o Material for MkDocs e estava bem satisfeito. Sempre gostei dele, mas, dois dias depois de deixar meu digital garden pronto, vi que o projeto havia entrado em modo de manutenção e receberia atualizações por apenas mais alguns meses.

Decidi migrar de uma vez, antes que ficasse com preguiça posteriormente.

Então fui pro Zensical. Ele foi criado por uma galera que participou do Material for MkDocs. É bem parecido e bem legal.

Então pronto: meu SSG é o Zensical, com Python 3.12 no CI.

Tenho o plugin Awesome Nav, com um arquivo .nav.yml, e umas extensões aí.

Como fontes, estou usando IBM Plex Sans e IBM Plex Mono, tudo self-hosted.

Nada demais, né? De fato, não é nada demais. Você só precisa ser criativo e pode ir longe em qualquer ambiente de desenvolvimento.

Chega de falação. Vamos ao que interessa: quer ver o que estou postando por lá? Vai no Docs do Murad.