Skip to content

pantoken-root / tools/demo/src / DemoMarkdownItOptions

Grensesnitt: DemoMarkdownItOptions ​

Alternativer for demoMarkdownIt: feltene fra resolveDemo pluss valgfri sammenføyning av live-eksempler.

Utvider ​

Egenskaper ​

base? ​

optional base?: string

Nettsidens basissti, f.eks. /pantoken/ (standard /).

Arvet fra ​

ResolveOptions.base


runnerPath? ​

optional runnerPath?: string

Runnerens sidesti, relativt til base (standard play/index.html).

Arvet fra ​

ResolveOptions.runnerPath


demosPath? ​

optional demosPath?: string

Selvhostet demo-kildekatalog, relativt til base (standard demos/).

Arvet fra ​

ResolveOptions.demosPath


cssUrls? ​

optional cssUrls?: readonly string[]

Stylesheet-URLer som runneren injiserer (i dens chrome og i hvert gjengitt resultat): komponent arkene, det multi-tema token-arket, og plugin-/surface-arkene. Runneren tematiserer ved å veksle data-pantoken-theme-attributtet, så ett token-ark dekker alle temaer.

Arvet fra ​

ResolveOptions.cssUrls


labels? ​

optional labels?: RunnerLabels

Lokaliserte RunnerLabels for runnerens visningsfaner, videresendt i runner-URL-en.

Arvet fra ​

ResolveOptions.labels


liveExample? ​

optional liveExample?: LiveExampleOptions

When set, appends a live preview after each html fence on matching pages — the same markup, rendered live, beneath its source. Overlay examples (<dialog>, [popover]) are skipped: they're hidden until opened, so a ## Demo iframe drives their preview instead.


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.

Parametere ​

relativePath ​

string

Returnerer ​

string


localeLabels? ​

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

Fastslå runnerens visningsfaneetiketter for gjeldende side, fra dens markdown-it env.relativePath

— samme lokaliseringsoppslag som DemoMarkdownItOptions.localePrefix. Utelat for et nettsted med én lokalitet

(site) (runneren viser da sine engelske standardverdier)).

Parametere ​

relativePath ​

string

Returnerer ​

RunnerLabels | undefined