pantoken / demo

demo ​

Beta

@pantoken/typedoc-plugin-demo — ein TypeDoc-plugin for @demo blokktagg.

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

Kodegjerdet går gjennom Markdown urørt — inkludert alle oversettingsrøyr som bevarar kodeblokker — så demonstrasjonen overlever lokalisering.

Oppsett: legg til "@demo" i TypeDoc sin blockTags-innstilling. Kommentarparseren les den lista før pluginar vert lasta, så ein plugin kan ikkje registrere taggen så seint at han undertrykkjer advarselen "ukjent blokktagg" ; han må vere i din typedoc.json.

Døme ​

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

Variablar ​

Funksjonar ​