Skip to content

pantoken / demo

demo

@pantoken/demo — gjengivelsessiden til @demo-systemet.

@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."

Den leveres med tre komponenter: resolveDemo (spec → iframe-attributter, rammeverksuavhengig), en markdown-it-plugin (demoMarkdownIt) som gjør om demo kodegjerder til panel-HTML, og en selvhostet runner (@pantoken/demo/runner.html) — en same-origin-side som henter en ren HTML/CSS/JS-demo og gjengir den med token-stilarkene dine injisert, slik at self:-demoer ikke trenger noen tredjepartskonto eller framing-omgåelser.

Eksempel

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;

Grensesnitt

Variabler

Funksjoner