banira
    Preparing search index...

    Interface DocGenOptions

    Options controlling the generated documentation page.

    interface DocGenOptions {
        safeDemos?: boolean;
        scriptSrc?: string;
        stylesheet?: Stylesheet;
    }
    Index

    Properties

    safeDemos? scriptSrc? stylesheet?

    Properties

    safeDemos?: boolean

    Render @demo previews inertly: the markup is shown inside a sandboxed (sandbox, no scripts) <iframe srcdoc> instead of being injected live into the page. Use this when documenting components you don't fully trust (e.g. via the MCP server), so a @demo block can't run script in the generated page. Default false (the live preview the CLI emits for the author's own component). See security-findings #3.

    scriptSrc?: string

    Override the component module src in the page. Default: ./dist/${tagName}.js.

    stylesheet?: Stylesheet

    Page stylesheet: an external { href }, inline { inline } CSS, or 'none'. Default: PicoCSS CDN.

    Settings

    Member Visibility

    On This Page

    Properties