Interface: BuildCssApiOptions
Defined in: emitters/markdown/src/build.ts:29
Options for buildCssApi.
Extends
Properties
baseHref?
optional baseHref?: string;Defined in: emitters/markdown/src/render.ts:36
Link prefix for page links (defaults to "/"; e.g. "/api/css/").
Inherited from
configuration?
optional configuration?: CssDocConfiguration;Defined in: emitters/markdown/src/build.ts:35
The tag configuration to parse with (e.g. from @cssdoc/config).
css
css: string | string[];Defined in: emitters/markdown/src/build.ts:31
The CSS source (one string, or several concatenated).
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
intro?
optional intro?: string;Defined in: emitters/markdown/src/render.ts:34
An intro paragraph under the H1.
Inherited from
outDir
outDir: string;Defined in: emitters/markdown/src/build.ts:33
The output directory (created if missing).
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
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
sidebarFileName?
optional sidebarFileName?: string;Defined in: emitters/markdown/src/build.ts:37
The sidebar file name (defaults to css-sidebar.json).
title?
optional title?: string;Defined in: emitters/markdown/src/render.ts:32
The index H1 (defaults to "CSS API reference").