Notation
Notation é uma ferramenta que permite escrever em Markdown e publicar automaticamente no Notion. Ele permite que você hospede sua documentação internamente ou como um site público, oferecendo uma poderosa função de busca AI.
Listado em categorias:
Ferramentas de desenvolvimentoEscritaGitHub
Descrição
Notation é uma ferramenta que permite escrever documentação em Markdown e publicá-la automaticamente no Notion. Ela se integra perfeitamente ao Notion, permitindo que você gerencie sua documentação ao lado do seu código, sem a necessidade de serviços separados. O Notation enfatiza uma filosofia de design onde a documentação vive com o código, é facilmente acessível e está sujeita aos mesmos processos de revisão que o código.
Como usar Notation?
Para usar o Notation, escreva sua documentação em Markdown, crie uma página no Notion para hospedá-la, obtenha uma chave de API do Notion e configure seu arquivo Notation.toml. Por fim, execute o comando 'notation ship src pathtoyoudocs' para ver sua documentação no Notion.
Recursos principais de Notation:
1️⃣
Escrever documentação em Markdown
2️⃣
Publicar automaticamente no Notion
3️⃣
Suporta documentação interna e pública
4️⃣
Utiliza a pesquisa e formatação de IA do Notion
5️⃣
Opções de implantação para acesso interno ou público
Por que usar Notation?
| # | Caso de uso | Status | |
|---|---|---|---|
| # 1 | Criar documentação interna para equipes | ✅ | |
| # 2 | Publicar documentação pública para produtos | ✅ | |
| # 3 | Gerenciar documentação ao lado do código em um repositório | ✅ | |
Desenvolvido por Notation?
O Notation é desenvolvido por uma equipe focada em simplificar o processo de documentação para desenvolvedores e não desenvolvedores. Eles priorizam a integração com ferramentas existentes e uma experiência amigável.