A fast, modern, LLM-friendly documentation theme for JSDoc and TypeDoc.

Point it at your source comments — and, optionally, a folder of Markdown guides — and it produces a static site: server-rendered HTML, lazily-hydrated interactive islands, fuzzy + full-text search, light and dark themes, and a companion .md of every page for LLMs. No CSS or build config required to get started.

Highlights

• JSDoc and TypeDoc — the same modern output from either toolchain.
• Fast & framework-free — server-rendered pages with lazily-hydrated Preact islands; each page loads only the JS it actually uses.
• Search built in — a fuzzy command palette (Ctrl K) over titles, descriptions, content, and per-member deep links, plus an optional Pagefind full-text index.
• Guides + API in one site — hand-written Markdown guides and the auto-generated reference share one sidebar and one search.
• Localization built in — declare your locales and the clean-jsdoc CLI builds one static site per language (translated UI, API descriptions, and prose) with a header language switcher, per-language fonts, and hreflang.
• LLM-friendly — every page ships a clean companion .md, plus a copy-page button to hand any page to Claude / ChatGPT / Perplexity. A downloadable skill turns any coding assistant into a setup expert.
• Polished by default — light/dark OKLCH themes, Google Fonts, shiki syntax highlighting, a Monaco source viewer, and Source: file:line links.

Quick start

npm install --save-dev clean-jsdoc-theme jsdoc

Add a jsdoc.json:

{
  "source": { "include": ["./src", "./README.md"] },
  "plugins": ["plugins/markdown"],
  "opts": {
    "destination": "dist",
    "recurse": true,
    "template": "node_modules/clean-jsdoc-theme/dist"
  }
}

Build, then serve over HTTP (Pagefind needs HTTP to load its index):

jsdoc -c jsdoc.json
npx serve dist

Documentation

• Guides & full reference — ankdev.me/clean-jsdoc-theme: installation, TypeDoc usage, configuration, and theming.
• FAQ & recipes — ankdev.me/clean-jsdoc-theme/guides/faq: how to embed CodePen / YouTube / sites, write rich doc comments (callouts, steps), and common config tweaks.
• Live demo — ankdev.me/clean-jsdoc-theme/api-docs: a real generated API reference, so you can see the output before installing.

License

MIT © Ankit Kumar