Emitting docs

Emitters consume the model and produce an output format — one package per format, the way typedoc-plugin-markdown and the default HTML theme are separate emitters over TypeDoc's reflections. Each takes CSS (or an already-parsed model) and writes files.

Markdown

@cssdoc/markdown writes one Markdown page per record, an index, and a css-sidebar.json compatible with typedoc-plugin-markdown / typedoc-vitepress-theme.

import { buildCssApi } from "@cssdoc/markdown";
import { readFileSync } from "node:fs";

buildCssApi({
  css: readFileSync("dist/components.css", "utf8"),
  outDir: "docs/api/css",
  baseHref: "/api/css/",
});

Pass a resolveToken hook to add a Type/Value column for consumed custom properties (e.g. resolve --your-* against a design-token source). renderEntry(entry) / renderIndex(entries) return strings if you'd rather place the output yourself.

HTML

@cssdoc/html writes standalone, self-contained HTML — one page per record plus an index, styled inline, dark-mode aware, no build step.

import { buildHtml } from "@cssdoc/html";
buildHtml({ css, outDir: "docs/api/html", title: "CSS API reference" });

JSON

@cssdoc/json writes the model as JSON — a whole-model file, optional per-record files with an index, and the model's JSON Schema for validating or typing the output.

import { writeJson } from "@cssdoc/json";
writeJson({ css, outDir: "docs/api/json", perRecord: true, schema: true });

llms.txt

@cssdoc/llms writes an llms.txt-style digest — a flat, token-efficient Markdown summary of every component's surface, sized for an LLM's context window.

import { writeLlms } from "@cssdoc/llms";
writeLlms({ css, outFile: "llms.txt", title: "My CSS" });

Alongside a TypeDoc site

@cssdoc/typedoc is a TypeDoc plugin: on render it emits the CSS reference (via @cssdoc/markdown) into the TypeDoc output and merges it into the TypeDoc sidebar, so CSS docs sit beside your TS API docs.

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