pantoken-root / tools/demo/src / DemoMarkdownItOptions

Interface: DemoMarkdownItOptions ​

Muligheder for demoMarkdownIt: resolveDemo felterne plus valgfri live-eksempel syning.

Udvider ​

Egenskaber ​

base? ​

optional base?: string

Sides basis-sti, f.eks. /pantoken/ (standard /).

Arvet fra ​

ResolveOptions.base

runnerPath? ​

optional runnerPath?: string

Runner side-sti, relativ til base (standard play/index.html).

Arvet fra ​

ResolveOptions.runnerPath

demosPath? ​

optional demosPath?: string

Self-hosted demo-kilde mappe, relativ til base (standard demos/).

Arvet fra ​

ResolveOptions.demosPath

cssUrls? ​

optional cssUrls?: readonly string[]

Stylesheet URL'er som runner'en injicerer (i dens chrome og hvert gengivet resultat): komponent- arkene, multi-tema token-arket, og plugin/overflade arkene. Runner'en temaiserer ved at slå data-pantoken-theme attributten til og fra, så et token-ark dækker alle temaer.

Arvet fra ​

ResolveOptions.cssUrls

labels? ​

optional labels?: RunnerLabels

Localiserede RunnerLabels til runnerens visningsfaner, videresendt i runner-URL'en.

Arvet fra ​

ResolveOptions.labels

liveExample? ​

optional liveExample?: LiveExampleOptions

Når det er sat, tilføjes en live forhåndsvisning efter hver html fold på matchende sider — den samme markup, gengivet live, under dens kilde. Overlay eksempler (<dialog>, [popover]) bliver sprunget over: de er gemte indtil de åbnes, så en ## Demo iframe kører deres forhåndsvisning i stedet.

localePrefix? ​

optional localePrefix?: (relativePath) => string

Route a demo:self:<name> fence to a locale-specific self-hosted demo directory, from the current page's markdown-it env.relativePath (e.g. "hu/" for pages under hu/, "" for the root locale). Prepended to demosPath so the localized clone of a demo (translated prose, same markup) loads instead of the English source. Omit for a single-locale site.

Parametre ​

relativePath ​

string

Returnerer ​

string

localeLabels? ​

optional localeLabels?: (relativePath) => RunnerLabels | undefined

Opløs runnerens visningsfane-etiketter for den aktuelle side fra dens markdown-it env.relativePath — samme lokalitetsopslag som DemoMarkdownItOptions.localePrefix. Udelad for et en-sproget site (runneren viser så sine engelske standardværdier)).

Parametre ​

relativePath ​

string

Returnerer ​

RunnerLabels | undefined