pantoken / demo

demo ​

Beta

@pantoken/typedoc-plugin-demo — yon plugin TypeDoc pou etikèt blòk @demo.

Authors attach a live, embeddable demo to any symbol with @demo <spec>, where <spec> is either a bare URL or a <provider>:<ref> pair (for example stackblitz:abc123, codesandbox:xy12z, wp-playground:https://…/blueprint.json, or self:button). This plugin registers nothing about providers itself — it stays deliberately dumb and reusable: it moves each @demo tag's spec into a fenced demo block appended to the symbol's summary, and your docs renderer decides how to turn a spec into an iframe. (See @pantoken/demo for a renderer that resolves the providers.)

Fens kòd la pase atravè markdown san chanje — enkli nenpòt pipeline tradiksyon ki konsève blòk kòd yo — kidonk demonstrasyon an siviv lokalizasyon.

Konfigirasyon: ajoute "@demo" nan opsyon blockTags TypeDoc la. Parseur kòmantè a li lis sa a anvan plugin yo chaje, kidonk yon plugin pa ka anrejistre etikèt la twò ta pou li anpeche avètisman "etikèt blòk enkoni"; li dwe nan typedoc.json ou a.

Egzanp ​

jsonc
// typedoc.json
{
  "plugin": ["typedoc-plugin-markdown", "@pantoken/typedoc-plugin-demo"],
  "blockTags": ["@param", "@returns", "@example", "@demo"]
}

Varyab ​

Fonksyon ​