Skip to content
compodocx

Reference

Everything compodocx documents

Twelve reference guides covering install through multi-version output. Skim, skip around, or read end to end.

  1. Features

    Standalone components, signals, multi-version, theming — the full output surface.
  2. Getting Started

    Install, configure, and ship your first build in under a minute.
  3. Usage

    tsconfig pointing, watch mode, npm scripts, monorepo flows.
  4. Options

    Every CLI flag and JSON config key, with defaults and gotchas.
  5. Comments

    Markdown-flavored JSDoc that compodocx actually reads.
  6. JSDoc Tags

    @param, @returns, @playground, @internal — supported tags and how each renders.
  7. Playground Blocks

    Author-curated runnable demos via @playground — click-to-launch StackBlitz projects per component.
  8. Live Example Tab

    Sandboxed component demos rendered alongside API docs.
  9. Themes

    Eight bundled themes plus rolling your own via --color-cdx-* tokens.
  10. Tab Configuration

    Reorder, hide, or extend per-entity tabs (API, examples, source).
  11. Routing

    Static SPA paths, basePath, hash vs. history strategy.
  12. Documentation Coverage

    Per-symbol coverage, --coverageMinimum CI gating, --publicApiOnly scoping.
  13. Tips and Tricks

    Real-world patterns for monorepos, design systems, libraries.