pantoken / demo

demo ​

Beta

@pantoken/typedoc-plugin-demo — TypeDoc vtičnik za oznako bloka @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.)

Razmejitev (fence) v Markdownu ostane nedotaknjena — vključno z vsakim prevajalskim potekom, ki ohranja kodne bloke — zato demo preživi lokalizacijo.

Namestitev: dodajte "@demo" v TypeDoc možnost blockTags. Parser komentarjev prebere ta seznam pred naložitvijo vtičnikov, zato vtičnik ne more registrirati oznake dovolj pozno, da bi utišal opozorilo "neznana oznaka bloka" ; mora biti v vašem typedoc.json.

Primer ​

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

Spremenljivke ​

Funkcije ​