Notation
Notation es una herramienta que te permite escribir en Markdown y publicar automáticamente en Notion. Te permite alojar tu documentación de forma interna o como un sitio web público, y ofrece una potente función de búsqueda AI.
Listado en categorías:
Herramientas de desarrolloEscrituraGitHub
Descripción
Notation es una herramienta que te permite escribir documentación en Markdown y publicarla automáticamente en Notion. Se integra a la perfección con Notion, lo que te permite gestionar tu documentación junto con tu código sin necesidad de servicios separados. Notation enfatiza una filosofía de diseño donde la documentación vive con el código, es fácilmente accesible y está sujeta a los mismos procesos de revisión que el código.
Cómo usar Notation?
Para usar Notation, escribe tu documentación en Markdown, crea una página de Notion para alojarla, obtén una clave API de Notion y configura tu archivo Notation.toml. Finalmente, ejecuta el comando 'notation ship src pathtoyoudocs' para ver tu documentación en Notion.
Características principales de Notation:
1️⃣
Escribir documentación en Markdown
2️⃣
Publicar automáticamente en Notion
3️⃣
Soporta documentación interna y pública
4️⃣
Utiliza la búsqueda y el formato de IA de Notion
5️⃣
Opciones de implementación para acceso interno o público
Por qué podría ser usado Notation?
| # | Caso de Uso | Estado | |
|---|---|---|---|
| # 1 | Crear documentación interna para equipos | ✅ | |
| # 2 | Publicar documentación pública para productos | ✅ | |
| # 3 | Gestionar documentación junto con el código en un repositorio | ✅ | |
Desarrollado por Notation?
Notation es desarrollado por un equipo enfocado en simplificar el proceso de documentación para desarrolladores y no desarrolladores por igual. Priorizan la integración con herramientas existentes y una experiencia fácil de usar.