Notation es una solución innovadora diseñada para simplificar la gestión de documentación técnica. Con Notation, los desarrolladores pueden escribir su documentación en Markdown y publicarla directamente en Notion, aprovechando las características avanzadas de Notion como la búsqueda AI, el formato atractivo y la organización en subpáginas. Esta herramienta es ideal para equipos que buscan mantener su documentación sincronizada con su código, asegurando que la información esté siempre actualizada y accesible.
El proceso de uso de Notation es sencillo: primero, se escribe la documentación en Markdown. Luego, se crea una página en Notion para alojar esta documentación. Después de obtener una clave API de Notion y configurarla en un archivo Notation.toml, se puede ejecutar el comando notation ship para publicar la documentación en Notion. Esto permite a los usuarios disfrutar de una documentación bien organizada, con características como una tabla de contenidos, búsqueda eficiente y la posibilidad de desplegar la documentación como un sitio web público.
Notation también ofrece funcionalidades adicionales, como la posibilidad de incluir contenido directamente en la página principal a través de un archivo intro.md, y soporte para argumentos CLI como títulos y emojis para personalizar la apariencia de las páginas en Notion. Además, Notation soporta una amplia gama de características de Markdown, incluyendo encabezados, párrafos, bloques de código, listas, tablas, enlaces e imágenes, facilitando la creación de documentación rica y detallada.
Para configurar Notation, los usuarios necesitan una cuenta de Notion, crear una página para alojar la documentación, y configurar una integración en Notion para conectar su página con Notation. Este proceso asegura que la documentación esté siempre sincronizada y accesible, tanto para equipos internos como para el público en general.
