Skip to content

Interface: WriteLlmsOptions ​

Defined in: emitters/llms/src/index.ts:155

Options for writeLlms.

Extends ​

Properties ​

configuration? ​

ts
configuration?: CssDocConfiguration;

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

Inherited from ​

ModelInput.configuration


css? ​

ts
css?: string | string[];

Defined in: emitters/llms/src/index.ts:21

Inherited from ​

ModelInput.css


dialect? ​

ts
dialect?: CssDialect;

Defined in: emitters/llms/src/index.ts:27

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

Inherited from ​

ModelInput.dialect


entries? ​

ts
entries?: CssDocEntry[];

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

Inherited from ​

ModelInput.entries


includeInternal? ​

ts
includeInternal?: boolean;

Defined in: emitters/llms/src/index.ts:46

Include records marked @visibility internal; defaults to false.

Inherited from ​

RenderLlmsOptions.includeInternal


intro? ​

ts
intro?: string;

Defined in: emitters/llms/src/index.ts:44

A one-line summary rendered as a blockquote under the title.

Inherited from ​

RenderLlmsOptions.intro


lang? ​

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

Defined in: emitters/llms/src/index.ts:25

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

Inherited from ​

ModelInput.lang


outFile? ​

ts
outFile?: string;

Defined in: emitters/llms/src/index.ts:157

Output file (default llms.txt).


title? ​

ts
title?: string;

Defined in: emitters/llms/src/index.ts:42

The H1 title (default "CSS components").

Inherited from ​

RenderLlmsOptions.title

Released under the MIT License