Skip to content

pantoken-root / tools/demo/src / DemoMarkdownItOptions

Grensesnitt: DemoMarkdownItOptions ​

Val for demoMarkdownIt: felta frå resolveDemo pluss valfri samansying av live-eksempel.

Utvidar ​

Eigenskapar ​

base? ​

optional base?: string

Basebane for sida, t.d. /pantoken/ (standard /).

Arva frå ​

ResolveOptions.base


runnerPath? ​

optional runnerPath?: string

Runner-sidesøkjar, relativt til base (standard play/index.html).

Arva frå ​

ResolveOptions.runnerPath


demosPath? ​

optional demosPath?: string

Sjølvhosta demo-kjeldekatalog, relativt til base (standard demos/).

Arva frå ​

ResolveOptions.demosPath


cssUrls? ​

optional cssUrls?: readonly string[]

Stilark-URLar som runneren injiserer (into its chrome and every rendered result): komponentsheets, det fleirtema-token-skjemaet, og plugin-/surface-sheets. Runneren set tema ved å skifte på data-pantoken-theme-attributtet, så eitt token-skjema dekkjer alle tema.

Arva frå ​

ResolveOptions.cssUrls


labels? ​

optional labels?: RunnerLabels

Lokaliserte RunnerLabels for runnerens visingsfaner, vidareført i runner-URL-en.

Arva frå ​

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.

Parametrar ​

relativePath ​

string

Returnerer ​

string


localeLabels? ​

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

Løys runnerens visingsfaner-etikettar for den gjeldande sida, frå markdown-it env.relativePath env.relativePath — same locale lookup as #localeprefix). Utelate for ei einspråkleg nettside (då viser runneren sine engelske standardverdiar__PTK_MD_12__).

Parametrar ​

relativePath ​

string

Returnerer ​

RunnerLabels | undefined