pantoken / demo

demo ​

Beta

@pantoken/typedoc-plugin-demo — TypeDoc-viðbót fyrir @demo blokkamerkið.

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.)

Girðingin fer óskemmd í gegnum markdown — þar með talið hvaða þýðingarferli sem varðveitir kóðablokkir — þannig að sýnidæmið lifir af staðfærslu.

Uppsetning: bættu "@demo" við blockTags valkost TypeDoc. Athugasemdargreinirinn les þann lista áður en viðbætur hlaðast, svo viðbót getur ekki skráð merkið nógu seint til að bæla "óþekkt blokkamerki" viðvörun; það verður að vera í typedoc.json þínum.

Dæmi ​

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

Breytur ​

Föll ​