Skip to content

Interface: BuildHtmlOptions ​

Defined in: emitters/html/src/index.ts:312

Options for buildHtml.

Extends ​

Properties ​

configuration? ​

ts
configuration?: CssDocConfiguration;

Defined in: emitters/html/src/index.ts:24

Inherited from ​

ModelInput.configuration


css? ​

ts
css?: string | string[];

Defined in: emitters/html/src/index.ts:22

Inherited from ​

ModelInput.css


dialect? ​

ts
dialect?: CssDialect;

Defined in: emitters/html/src/index.ts:28

The stylesheet dialect of css (scss/less pick a dialect parser). Default css.

Inherited from ​

ModelInput.dialect


entries? ​

ts
entries?: CssDocEntry[];

Defined in: emitters/html/src/index.ts:23

Inherited from ​

ModelInput.entries


exampleFilter? ​

ts
exampleFilter?: ExampleFilter | null;

Defined in: emitters/html/src/index.ts:315


includeInternal? ​

ts
includeInternal?: boolean;

Defined in: emitters/html/src/index.ts:317

Include records marked @visibility internal; defaults to false.


lang? ​

ts
lang?: "css" | "markdown" | "html" | "js";

Defined in: emitters/html/src/index.ts:26

The host language css is written in. Non-css values extract embedded CSS first. Default css.

Inherited from ​

ModelInput.lang


outDir ​

ts
outDir: string;

Defined in: emitters/html/src/index.ts:313


title? ​

ts
title?: string;

Defined in: emitters/html/src/index.ts:314

Released under the MIT License