Notation

Notation è un'ottima soluzione per chi lavora con il markdown e vuole pubblicarlo su Notion. Dopo averlo installato con il comando curl, si può modificare la configurazione in ~/.notation/Notation.toml. Il design di Notation si basa su alcuni principi fondamentali. La documentazione non deve essere gestita separatamente dal repository, ma deve stare insieme al codice, come se fossero inseparabili. Inoltre, non c'è bisogno di accedere a un servizio esterno per aggiornare i documenti dopo il merge e la distribuzione del codice. L'unico framework frontend che Notation prende in considerazione è il markdown, perché è ritenuto più semplice e pratico. Inoltre, Notation rende la documentazione facilmente ricercabile e la sottopone allo stesso processo di revisione e CI del codice. Con Notation, si possono scegliere diverse opzioni di distribuzione, come tenere la documentazione interna al proprio spazio di lavoro Notion, pubblicarla come pagina Notion o distribuirla come un sito web completo. Inoltre, Notation offre alcune funzionalità extra, come l'utilizzo di un file intro.md per pubblicare contenuti direttamente sulla pagina principale e il supporto di argomenti passati come flag CLI nella parte superiore del file markdown. Per configurare Notation, bisogna creare un file Notation.toml accanto al binario di Notation. Per impostare tutto, bisogna avere un account Notion, creare una pagina per ospitare la documentazione, creare un'integrazione in Notion e collegare la pagina all'integrazione corrispondente.