pantoken / demo

demo ​

Beta

@pantoken/typedoc-plugin-demo — en TypeDoc-plugin för @demo blocktagg.

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

Kodavgränsaren går igenom markdown orörd — inklusive alla översättningspipelines som bevarar kodblock — så demonstrationen överlever lokaliseringen.

Konfiguration: lägg till "@demo" i TypeDocs blockTags-alternativ. Kommentartolkaren läser den listan innan plugins laddas, så en plugin kan inte registrera taggen sent nog för att undertrycka varningen "unknown block tag" ; den måste finnas i din typedoc.json.

Exempel ​

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

Variabler ​

Funktioner ​