Skip to content

pantoken / demo

demo

@pantoken/demo — phần kết xuất của hệ thống @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."

Nó cung cấp ba thứ: resolveDemo (spec → thuộc tính iframe, không phụ thuộc vào framework), một plugin markdown-it (demoMarkdownIt) biến các khối demo thành HTML của panel, và một trình chạy tự lưu trữ (@pantoken/demo/runner.html) — một trang cùng nguồn (same-origin) tải về bản demo HTML/CSS/JS thuần túy và kết xuất nó với các stylesheet token của bạn được chèn vào, nên các demo self: không cần tài khoản bên thứ ba và không cần các thủ thuật đóng khung.

Ví dụ

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;

Giao diện

Biến

Hàm