Skip to content

pantoken / demo

demo

@pantoken/demo — le côté rendu du système @demo.

@pantoken/typedoc-plugin-demo turns a @demo <spec> tag into a fenced demo block whose body is the spec (a bare URL or a <provider>:<ref> pair). This package resolves that spec into an embeddable iframe and renders the surrounding panel — an MDN-style "live sample."

Il livre trois choses : resolveDemo (spec → attributs iframe, indépendant du framework), un plugin markdown-it (demoMarkdownIt) qui transforme les blocs demo en HTML du panneau, et un exécuteur auto-hébergé (@pantoken/demo/runner.html) — une page de même origine qui récupère une démo HTML/CSS/JS brute et la rend avec vos feuilles de style de tokens injectées, donc les démos self: n'ont besoin ni de compte tiers ni de contournements de framing.

Exemple

ts
import { resolveDemo } from "@pantoken/demo";

resolveDemo("stackblitz:abc123").src; // → "https://stackblitz.com/edit/abc123?embed=1&…"
resolveDemo("self:button", { base: "/docs/", cssUrls: ["/docs/tokens.css"] }).src;

Interfaces

Variables

Fonctions