notabene-authoringlisted
Install: claude install-skill z29k/notabene
<!-- Generated from docs/guide/authoring.md + packages/claude-plugin/overlays/notabene-authoring.md by scripts/gen-protocol.mjs — do not edit. -->
# Authoring notabene docs — the rendering palette
What actually renders in a notabene site, so you can write a **complete** doc with every
tool available and nothing that silently degrades to plain text. Docs are plain files in
the repo (Markdown/MDX), rendered by the notabene renderer (Astro + GFM + Shiki + Mermaid).
Run every CLI command shown below through the plugin forwarder —
`node "${CLAUDE_PLUGIN_ROOT}/bin/nb.mjs" <cmd> --root <repo-root>` — never `npx notabene`
(unscoped: not our package).
## First: know the format
Read `format` in `notabene.config.mjs` (or run `npx -y @z29k/notabene@latest doctor --json`).
It decides the pipeline:
- **`commonmark`** (the `init` default) — globs `.md` + `.markdown`, **lenient** CommonMark/GFM,
**no MDX**. `<`, `{`, `Promise<T>`, raw HTML, GFM tables all render without a crash. Simplest.
- **`mdx`** — globs `.md` + `.mdx`. `.md` stays lenient; **`.mdx` is strict** (JSX/expressions):
a stray `{` or `<` outside a code fence is a build error.
Everything below works in **both** formats. The MDX-only extras (components/expressions) are
called out at the end.
## The palette (all verified to render)
- **Prose + CommonMark**: headings, lists, `**bold**`, `_italic_`, `> blockquotes`, `---` rules,
inline `` `code` ``, links.
- **GFM**: tables, task lists (`- [ ] todo` / `- [x] done`),