Skip to content

@cssdoc/typedoc

@cssdoc/typedoc — a TypeDoc plugin that makes CSS docs ride along with a TS API-docs build. On RendererEvent.END it renders CSS reference pages (via @cssdoc/markdown) into the TypeDoc output and merges them into typedoc-sidebar.json, so the CSS reference themes identically and sits in the same nav — the cssdoc-specific half of a CSS-API generator, codified.

Register it and point it at your CSS in typedoc.json:

Example

jsonc
// typedoc.json
{
  "plugin": ["typedoc-plugin-markdown", "typedoc-vitepress-theme", "@cssdoc/typedoc"],
  "cssdocCss": ["../packages/ui/dist/components.css"],
  "cssdocOut": "css",
  "cssdocLabel": "CSS",
  "cssdocBaseHref": "/api/css/"
}

(The generic @demo block-tag rewriter is a separate TypeDoc plugin, unrelated to CSS.)

Interfaces

Variables

Functions

Released under the MIT License