package
A modern JSDoc theme with dark mode, built-in search, i18n, and LLM-ready Markdown for every page. TypeDoc support via @clean-jsdoc-theme/typedoc.
npm install clean-jsdoc-themeGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
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.
Ctrl K) over titles,
descriptions, content, and per-member deep links. Always on, nothing to
configure.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..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.Source: file:line links.npm install --save-dev clean-jsdoc-theme jsdocAdd 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 (the island chunks and the search index are fetched, which file:// blocks):
jsdoc -c jsdoc.json
npx serve dist@clean-jsdoc-theme/typedoc — the TypeDoc plugin with the same look and feature set.Thanks to everyone who has helped build clean-jsdoc-theme.
Estimated unpacked size across 60 packages.
51.0 MB+
Includes dependencies.
7 direct · 2 outdated
^9.3.0
10.0.0
^10.22.0
11.2.0
^5.3.0
5.3.0
^5.3.0
5.3.0
^5.3.0
5.3.0
^5.3.0
5.3.0
5.3.0