Notation: Uma Ferramenta para Publicação de Markdown no Notion
Notation é uma solução interessante para quem trabalha com documentação. Ela permite que você escreva em markdown e automaticamente publique no Notion. Com isso, você aproveita todos os recursos do Notion, como AI, busca e formatação, sem precisar lidar com complexidades adicionais.
Core Features:
- A documentação não precisa ser gerenciada separadamente do repositório, seguindo a filosofia de que ela deve estar junto com o código.
- Não é necessário fazer login em algum serviço separado para atualizar a documentação após a mesclagem e implantação do código.
- Utiliza Markdown como framework de frontend, evitando a complexidade de outras opções.
- Permite que pessoas que não são engenheiros também possam ler e entender a documentação.
- A documentação é altamente pesquisável.
- Está sujeita ao mesmo processo de revisão e CI que o código.
Basic Usage:
- Escreva sua documentação em markdown.
- Crie uma página no Notion para hospedar a documentação.
- Obtenha uma chave API do Notion e insira-a em um arquivo ~/.notation/Notation.toml.
- Execute o comando
notation ship --src </path/to/you/docs>para ver a documentação no Notion.
Além disso, Notation oferece alguns extras interessantes, como a possibilidade de colocar conteúdo diretamente na página pai usando um arquivo intro.md e o suporte a argumentos passados como flags CLI no arquivo Markdown para definir título e ícone da página.
