Notation é uma solução inovadora que simplifica o processo de documentação para desenvolvedores e equipes. Com a premissa de que a documentação deve viver junto com o código, Notation permite que você escreva seus documentos em markdown e os publique diretamente no Notion. Isso não apenas facilita a manutenção e atualização da documentação, mas também aproveita as poderosas funcionalidades do Notion, como pesquisa, formatação e IA integrada.
A filosofia por trás do Notation é clara: a documentação não deve ser gerenciada separadamente do repositório de código. Ela deve estar tão próxima do código quanto possível, facilitando a atualização e revisão. Além disso, Notation elimina a necessidade de ferramentas complicadas de frontend ou a implantação de sites separados para documentação. Tudo o que você precisa é escrever em markdown, e Notation cuida do resto.
Uma das grandes vantagens do Notation é a sua simplicidade. Você pode manter sua documentação interna para sua equipe, publicá-la como uma página no Notion ou até mesmo implantá-la como um site completo usando serviços como super.so. Notation também oferece extras úteis, como a capacidade de adicionar conteúdo diretamente na página principal através de um arquivo intro.md e suporte para argumentos CLI para personalizar títulos e ícones das páginas.
Configurar o Notation é simples. Após criar uma conta no Notion e configurar uma página para hospedar sua documentação, você só precisa de uma chave de API do Notion e um arquivo de configuração Notation.toml. Com isso, você pode começar a publicar sua documentação com um único comando.
Notation suporta uma variedade de funcionalidades markdown, incluindo cabeçalhos, parágrafos, blocos de código, listas, tabelas, links e imagens. Ele também permite a criação de uma estrutura de diretórios arbitrária, que será refletida em subpáginas no Notion.
Para desenvolvedores que valorizam a eficiência e a simplicidade, Notation é uma ferramenta essencial que transforma a maneira como a documentação é criada, gerenciada e publicada.
