pantoken / demo

demo ​

Beta

@pantoken/typedoc-plugin-demo — he tāpiritanga TypeDoc mō te tapanga poraka @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.)

Ka noho kāore i paahitia te ārai i roto i te markdown — tae atu ki ngā putanga whakamāori e tiakina ana ngā poraka waehere — nō reira ka ora tonu te whakaaturanga i te whakamāori.

Tāutanga: tāpirihia "@demo" ki te kōwhiringa blockTags o TypeDoc. Ka pānui te kaitātari kōrero i taua rārangi i mua i te utaina o ngā tāpiritanga, nō reira kāore e taea e tētahi tāpiritanga te rēhita i te tapanga i te wā whakamuri kia whakamārite i te whakatūpato "tapanga poraka kāore i te mōhiotia" me noho i roto i tō typedoc.json.

Tauira ​

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

Ngā Taipūtī ​

Ngā Mahi ​