pantoken-root / tools/demo/src / DemoMarkdownItOptions

Interface: DemoMarkdownItOptions ​

Opties voor demoMarkdownIt: de velden van resolveDemo plus optionele live-voorbeeldsamenvoeging.

Breidt uit ​

Eigenschappen ​

base? ​

optional base?: string

Basispad van de site, bijv. /pantoken/ (standaard /).

Geërfd van ​

ResolveOptions.base

runnerPath? ​

optional runnerPath?: string

Pad van de runner-pagina, relatief ten opzichte van base (standaard play/index.html).

Geërfd van ​

ResolveOptions.runnerPath

demosPath? ​

optional demosPath?: string

Zelf-gehoste demo-bronmap, relatief ten opzichte van base (standaard demos/).

Geërfd van ​

ResolveOptions.demosPath

cssUrls? ​

optional cssUrls?: readonly string[]

Stylesheet-URL's die de runner injecteert (in zijn chrome en elk gerenderd resultaat): de componentstijlen, het multi-theme token-stijlblad en de plugin-/surface-stijlbladen. De runner bepaalt thema's door het data-pantoken-theme-attribuut te schakelen, zodat één token-stijlblad elk thema dekt.

Geërfd van ​

ResolveOptions.cssUrls

labels? ​

optional labels?: RunnerLabels

Gelokaliseerde RunnerLabels voor de weergavetabbladen van de runner, doorgestuurd in de runner-URL.

Geërfd van ​

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.

Parameters ​

relativePath ​

string

Retourneert ​

string

localeLabels? ​

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

Los de weergavetabbladlabels van de runner op voor de huidige pagina, vanuit zijn markdown-it env.relativePath — dezelfde locale-opzoeking als DemoMarkdownItOptions.localePrefix. Weglaten voor een site met één locale site (de runner toont dan zijn Engelse standaardwaarden).

Parameters ​

relativePath ​

string

Retourneert ​

RunnerLabels | undefined