How do I install notabene?

Run these in Claude Code: npx -y skills add z29k/notabene. Then prompt normally.

Does notabene auto-invoke its skills?

Not yet. It is indexed on Flowy as a plain plugin. Request auto-invocation on its page and Flowy will route its skills for you as you prompt.

Yes. Flowy is free and open source, with nothing gated. You can read every skill in full before you install.

Documentation

notabene

Leave notes in the margins of your repo's docs then let your AI agent apply them, resolve the threads, and journal what changed & why.

FLOW.md

z29k@z29k

GitHub

Plugin Signal61/100Solid

maintained

claude code

> /plugin marketplace add z29k/notabene
> /plugin install notabene@z29k

Stats

Python JavaScript Node Astro CSS

What's inside

Skills

/notabene-authoringWhat you can put in a notabene doc — the full rendering palette, so you can author or expand documentation using everything the renderer supports. Use when writing or editing docs in a notabene repo: "write the documentation for X", "add a docs page", "document this feature",

FAQ

notabene is a Claude Code plugin with 3 hand-picked skills for documentation work, indexed on Flowy. Install it with the command on its page. It includes notabene-authoring, notabene-setup, notabene. Its skills do not fire on their own yet. Request auto-invocation to have Flowy route them as you prompt. Free and open source.

What is notabene?: Leave notes in the margins of your repo's docs then let your AI agent apply them, resolve the threads, and journal what changed & why.
How do I install notabene?: Run these in Claude Code: npx -y skills add z29k/notabene. Then prompt normally.
Does notabene auto-invoke its skills?: Not yet. It is indexed on Flowy as a plain plugin. Request auto-invocation on its page and Flowy will route its skills for you as you prompt.
Is notabene free?: Yes. Flowy is free and open source, with nothing gated. You can read every skill in full before you install.

Flowy

How it works (30 seconds)

npx notabene dev → open the site, select any text → leave a comment (or comment a whole page, diagram or image).

Tell your agent: "address the doc comments."

The agent reads .notabene/, edits the docs faithfully, marks each comment resolved, and appends a journal entry (what / why / which comments).

Read the trail at /journal - or validate each real git diff yourself in approve mode.

Try it

npm install -D @z29k/notabene # or pnpm / bun npx notabene init # writes the config, the .notabene store + the agent protocol npx notabene dev # → http://localhost:3009

Using Claude Code? /plugin marketplace add z29k/notabene then /plugin install notabene@z29k - and just say "set up notabene". → Full install guide

Features

Each one is a link into the documentation - go deep only where you're curious:

Anchored comments - select text on the rendered page, or comment a whole page, diagram or image. Threads, resolve, hold, a global /comments view, touch-first on mobile.

The agent review loop - a file-I/O-first protocol any agent can follow (no server, no port, no MCP). Ships as a Claude Code skill; the skill file is the spec.

Two-phase review - approve mode: the agent proposes, you validate each edit against its real git diff (cascades included) at /review.

A real doc site - spaces, frontmatter-driven sidebar, search, commentable Mermaid diagrams with a pan/zoom lightbox, a light/dark toggle, responsive.

MDX and CommonMark/GFM - lenient .md, strict .mdx, mixable per extension.

Multi-language docs - clean prefixed URLs, a language switcher, per-language comments, EN/FR/… .

PDF export - any page, folder, space or the whole doc: cover + clickable TOC in the browser, or a bookmarked PDF via notabene pdf.

Make it yours - a custom home page, logo + favicon + social card, navigation links (topbar, sidebar block, site footer), and theming via stable --nb-* design tokens, your own fonts, a code theme, or your own stylesheet (cascade-layer-safe: your CSS always wins).

Publish a public site - a read-only static build with an agent-readable surface (, per-page Markdown twins, sitemap, OpenGraph), private-content scoping, optional (Pagefind: per-language stemming, highlighted excerpts — in the dev app too), GitHub Pages workflow included. The is notabene publishing itself.

.claude-plugin/ marketplace.json .github/ workflows/ ci.yml docs.yml publish.yml .gitignore AGENTS.md assets/ notabene-demo.gif notabene-diagrams-demo.gif notabene-i18n-demo.gif notabene-logo.jpg notabene-mobile-demo.gif notabene-nav-demo.gif notabene-pdf-demo.gif notabene-theme-demo.gif social-preview.png CLAUDE.md CONTRIBUTING.md docs/ .notabene/ meta.json protocol.md guide/ authoring.md configuration.fr.md configuration.md customize.fr.md customize.md first-review.fr.md first-review.md index.fr.md index.md install.fr.md install.md multilingual.fr.md multilingual.md pdf-export.fr.md pdf-export.md publish/ configuration.fr.md configuration.md github-pages.fr.md github-pages.md index.fr.md index.md private-content.fr.md private-content.md server-side-domain.fr.md server-side-domain.md review-loop.fr.md review-loop.md home.fr.md home.md reference/ agent-protocol.md cli.fr.md cli.md config.fr.md config.md frontmatter.fr.md frontmatter.md index.fr.md index.md safety.fr.md safety.md store-contract.fr.md store-contract.md LICENSE notabene.config.mjs package-lock.json package.json packages/ claude-plugin/ .claude-plugin/ plugin.json bin/ nb.mjs commands/ dev.md review.md setup.md status.md stop.md overlays/ notabene-authoring.md notabene.md README.md skills/ notabene/ notabene-authoring/ SKILL.md notabene-setup/ SKILL.md SKILL.md renderer/ astro.config.mjs bin/ notabene.mjs biome.json LICENSE package.json protocol.md README.md src/ app-routes/ api/ comments.ts diff.ts journal.ts comments.astro journal.astro review.astro asset-routes/ branding.ts components/ Comments.astro NavLinks.astro NavTree.astro PublicZoom.astro ReviewChrome.astro Sidebar.astro SiteHome.astro SpaceIndex.astro Toc.astro config.mjs content.config.ts i18n.mjs integrations/ app-routes.mjs asset-routes.mjs dev-assets.mjs dev-search.mjs public-routes.mjs route-truth.mjs layouts/ DocLayout.astro PrintLayout.astro lib/ agents-md.mjs asset-dir.mjs asset-types.mjs base.ts client/ blocks-lightbox.ts blocks.ts comments-client.ts diff.ts esc.ts lightbox.ts mermaid-theme.ts mermaid.ts print.ts review-card.ts scheme.ts search-hits.ts shell.ts comment-mutate.mjs comment-types.ts comments.ts dev-search.mjs doctor.mjs git-dates.mjs i18n-content.mjs icons.ts journal.ts lint-links.mjs llms-content.ts llms.ts nav-icons.mjs nav-links.mjs nav.ts page-file.ts pan-zoom.ts print-scope.ts protocol-gen.mjs public-filter.ts server-process.mjs shiki-themes.mjs store-meta.ts store-path.ts store-verify.mjs theme-tokens.mjs write-guard.ts pages/ [...loc]/ llms-full.txt.ts llms.txt.ts [...path]/ [...path].astro index.md.ts 404.astro index.astro print/ [...scope].astro search-index.json.ts public-routes/ robots.txt.ts remark/ mermaid.mjs rewrite-links.mjs styles/ global.css print.css templates/ notabene.config.mjs test/ agents-md.test.ts asset-dir.test.ts asset-types.test.ts author.test.ts base.test.ts blocks.test.ts comment-mutate.test.ts dev-search.test.ts diff.test.ts doctor.test.ts fixtures/ notabene.config.mjs git-dates.test.ts i18n-content.test.ts identity.test.ts lint-links.test.ts llms.test.ts mermaid-theme.test.ts mermaid.test.ts nav-links.test.ts nav.test.ts page-file.test.ts pan-zoom.test.ts print-scope.test.ts protocol-gen.test.ts public-filter.test.ts review-card.test.ts rewrite-links.test.ts route.test.ts scheme.test.ts search-hits.test.ts server-process.test.ts shiki-themes.test.ts store-meta.test.ts store-path.test.ts store-verify.test.ts stubs/ astro-content.ts theme-tokens.test.ts write-guard.test.ts zero-config.test.ts tsconfig.json vitest.config.ts README.fr.md README.md scripts/ gen-fixture.mjs gen-protocol.mjs record-diagrams-demo.mjs record-hero-demo.mjs record-i18n-demo.mjs record-mobile-demo.mjs record-nav-demo.mjs record-pdf-demo.mjs record-theme-demo.mjs

notabene

Skills

notabene

Skills

Badges

README

How it works (30 seconds)

Try it

Features

Repo layout

License

File tree