banira doc

Generate an HTML documentation page for a component — the TSDoc summary and @demo blocks combined with a full API reference derived from the manifest.

Usage

$ banira doc <file> [options]

Arguments

ArgumentDescription
<file>TypeScript file to document.

Options

OptionDescription
-o, --output <path>Write the page to a file instead of stdout.
--script-src <path>Component module src used in the page. (default: ./dist/.js)
--stylesheet <value>A URL, a local .css file to inline, or 'none'. (default: PicoCSS CDN)

Examples

write a doc page
$ banira doc src/my-button.ts -o docs/my-button.html
offline / self-contained page
$ banira doc src/my-button.ts --stylesheet ./theme.css --script-src ./my-button.js

Notes

The reference covers attributes, properties, methods, events, slots, CSS parts and CSS custom properties. By default the page links PicoCSS from a CDN, so it needs network access to be styled. For a fully offline page, pass a local .css file to --stylesheet — it is inlined — or none for no stylesheet at all.