notabene

nota bene — la marque de marge qui signifie « à bien noter ».

Des notes dans les marges des docs du repo — directement sur la page rendue — puis l’agent IA les applique, résout les fils et journalise ce qui a changé & pourquoi. Le commentaire ancré est l’instruction : situé, sans ambiguïté, rien à citer. Sans SaaS, sans base de données — tout vit en JSON dans votre git.

La boucle, en 30 secondes

1. npx notabene dev → ouvrir le site, sélectionner du texte → laisser un commentaire (ou commenter une page entière, un diagramme ou une image).
2. Demander à l’agent : « traite les commentaires de la doc ».
3. L’agent lit .notabene/, édite les docs fidèlement, marque chaque commentaire résolu et ajoute une entrée de journal — ou, en mode approve, attend que vous validiez le vrai diff git de chaque édition.
4. Relire la trace sur /journal.

Commencer ici

• Installation — le renderer npm, le plugin Claude Code, ou les deux ; puis votre première revue de bout en bout.
• Configuration — un seul fichier de données : espaces, format, sidebar, mode de revue.

Aller plus loin

• La boucle de revue — le protocole file-I/O-first que n’importe quel agent peut suivre, et le mode approve avec humain dans la boucle.
• Personnaliser le rendu — branding, tokens --nb-*, votre propre feuille de style, polices, thèmes de code et de diagrammes.
• Liens de navigation — ramenez le lecteur au repo, aux releases, au produit : topbar, bloc de sidebar, pied de page.
• Doc multilingue — URL propres préfixées, sélecteur de langue, commentaires par langue.
• Export PDF — vues prêtes à imprimer, PDF avec signets.
• Publier un site public — le build statique en lecture seule, lisible par les agents. Ce site en est un : il expose /llms.txt, un double Markdown par page, et il est déployé par le workflow GitHub Pages.

Les tableaux exhaustifs vivent dans la Référence : la CLI, chaque clé de config, le frontmatter, le contrat du store et le modèle de sécurité.

Parcourir la doc