Interface: ProviderRef

Defined in: packages/config/src/CssDocConfigFile.ts:87

An upstream cssdoc provider this config consumes. path points at the provider's published model (model.json, the JSON emitter's output) or a source stylesheet (.css/.scss/…) — resolved relative to this file for .-paths, else via Node resolution (so a package specifier works). baseHref prefixes links to the provider's rendered doc pages (<baseHref><name>.md).

Properties

baseHref?

optional baseHref?: string;

Defined in: packages/config/src/CssDocConfigFile.ts:89

---

path

path: string;

Defined in: packages/config/src/CssDocConfigFile.ts:88

---

prefix?

optional prefix?: object;

Defined in: packages/config/src/CssDocConfigFile.ts:100

Rewrite the provider's base-class prefix before merging its records — for a provider published under one prefix spelling (e.g. a published instui-) but consumed under a different one. from matches the START of each class name (no leading ./^ needed): a literal string by default, or — when isRegExp is true — a regex source (anchored, so it always matches from the start; keep it to valid CSS identifier characters). to is the literal replacement text, used verbatim — no separator like - is added or assumed — so { from: "instui-", to: "i" } turns .instui-alert into .ialert, and { from: "instui-", to: "" } (or omitting to) strips it to a bare .alert. Omit prefix entirely to use the provider's classes exactly as published.

from

from: string;

isRegExp?

optional isRegExp?: boolean;

to?

optional to?: string;