clean-jsdoc-theme API

API reference demo

This is a live API reference, generated by clean-jsdoc-theme — the exact output you get from pointing JSDoc at the theme. Every page here was built from a small, fully-commented sample library, Forge, in src/; nothing was written by hand. Forge isn't real — it exists to exercise, on one site, every JSDoc construct and every authoring component the theme understands.

Press Ctrl K to fuzzy-search every symbol, or browse from the sidebar. Toggle light/dark in the header, and use the copy page button at the top of any page to hand its Markdown to Claude, ChatGPT, or Perplexity.

Start exploring

  • forge — the landing module. It opens with [!NOTE] / [!TIP] callouts, a <steps> walkthrough, install <tabs>, a feature table, and a live @iframe embed — all authored inline in the @module doc comment.
  • Cache — the showcase class: constructor with nested params, a @readonly getter, a @deprecated method, a @fires event, and an @example wired to a playground.
  • Queue — an @extends class with events, an @async method, a @generator, an @abstract method, and @protected internals.
  • Store & Timestamped — an @interface and a @mixin, with @implements / @mixes shown on the classes that use them.
  • text — a @namespace of helpers, plus a @borrows alias.
  • Globals — free functions, constants, and an enum aggregated onto one page (e.g. defineTask).

What it shows off

  • Every container kind — modules, classes, interfaces, mixins, namespaces — plus typedefs, @callbacks, enums, events, constants, and the Globals page.
  • The full member-tag set — params/returns/yields/throws/properties, modifiers (@async, @abstract, @readonly, …), relations (@extends, @implements, @mixes, @borrows), @fires/@listens, @deprecated, and metadata (@since, @version, @author, @see, @todo, …).
  • The theme's custom tags — @category / @order for the sidebar, @iframe for embeds, and @playground for runnable examples.
  • Authoring components in comments — every callout type, steps, tabs, tables, embeds, and playgrounds, written straight into JSDoc, not just prose.
  • @link cross-references resolved to real anchors, a companion .md beside every page, and Source: file:line links into a read-only Monaco viewer.

New here? The clean-jsdoc-theme Guide link in the sidebar opens the full documentation — installation, configuration, and theming.