Interface: EmitCssApiOptions

Defined in: plugins/typedoc/src/emit.ts:23

Options for emitCssApi.

Extends

• RenderEntryOptions

Properties

baseHref?

optional baseHref?: string;

Defined in: plugins/typedoc/src/emit.ts:33

Link prefix for the emitted pages/sidebar (default "<outSubdir>/").

---

configuration?

optional configuration?: CssDocConfiguration;

Defined in: plugins/typedoc/src/emit.ts:35

The tag configuration to parse with.

---

css

css: string[];

Defined in: plugins/typedoc/src/emit.ts:27

CSS source file paths (resolved against cwd).

---

cwd?

optional cwd?: string;

Defined in: plugins/typedoc/src/emit.ts:37

Base directory the css paths are resolved against (default process.cwd()).

---

headingPrefix?

optional headingPrefix?: string;

Defined in: emitters/markdown/src/render.ts:26

Heading prefix for the page title (defaults to no prefix, i.e. just the record name).

Inherited from

RenderEntryOptions.headingPrefix

---

label?

optional label?: string;

Defined in: plugins/typedoc/src/emit.ts:31

The sidebar section label (default "CSS").

---

outputDirectory

outputDirectory: string;

Defined in: plugins/typedoc/src/emit.ts:25

The TypeDoc output root (where typedoc-sidebar.json lives).

---

outSubdir?

optional outSubdir?: string;

Defined in: plugins/typedoc/src/emit.ts:29

Subdirectory under the output root for the CSS pages (default "css").

---

resolveDemo?

optional resolveDemo?: (entry) => string | undefined;

Defined in: emitters/markdown/src/render.ts:24

Choose the demo spec for an entry (defaults to entry.demo).

Parameters

entry

CssDocEntry

Returns

string | undefined

Inherited from

RenderEntryOptions.resolveDemo

---

resolveToken?

optional resolveToken?: ResolveToken;

Defined in: emitters/markdown/src/render.ts:22

Resolve a consumed token's type/value (adds Type + Value columns to "Tokens consumed").

Inherited from

RenderEntryOptions.resolveToken