pantoken-root / tools/demo/src / DemoMarkdownItOptions

Interface: DemoMarkdownItOptions ​

Options pour demoMarkdownIt : les champs de resolveDemo plus l'assemblage optionnel d'exemples en direct.

Étend ​

Propriétés ​

base? ​

optional base?: string

Chemin de base du site, p.ex. /pantoken/ (par défaut /).

Hérité de ​

ResolveOptions.base

runnerPath? ​

optional runnerPath?: string

Chemin de la page du runner, relatif à base (par défaut play/index.html).

Hérité de ​

ResolveOptions.runnerPath

demosPath? ​

optional demosPath?: string

Répertoire source des démos auto-hébergées, relatif à base (par défaut demos/).

Hérité de ​

ResolveOptions.demosPath

cssUrls? ​

optional cssUrls?: readonly string[]

URLs des feuilles de style que le runner injecte (dans son chrome et dans chaque résultat rendu) : les feuilles de composants, la feuille de jetons multi‑thèmes et les feuilles de plugin/surface. Le runner applique les thèmes en basculant l'attribut data-pantoken-theme, donc une seule feuille de jetons couvre tous les thèmes.

Hérité de ​

ResolveOptions.cssUrls

labels? ​

optional labels?: RunnerLabels

Libellés localisés RunnerLabels pour les onglets de vue du runner, transmis dans l'URL du runner.

Hérité de ​

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.

Paramètres ​

relativePath ​

string

Retourne ​

string

localeLabels? ​

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

Résout les libellés des onglets de vue du runner pour la page courante, à partir de son markdown-it env.relativePath

— la même recherche de locale que DemoMarkdownItOptions.localePrefix. Omettre pour un site à locale unique (le runner affiche alors ses valeurs anglaises par défaut).

Paramètres ​

relativePath ​

string

Retourne ​

RunnerLabels | undefined