pantoken / demo

demo ​

Beta

@pantoken/typedoc-plugin-demo — um plugin do TypeDoc para a tag de bloco @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.)

O fence atravessa o markdown intacto — incluindo qualquer pipeline de tradução que preserve blocos de código — portanto a demonstração sobrevive à localização.

Configuração: adicione "@demo" à opção blockTags do TypeDoc. O parser de comentários lê essa lista antes que os plugins sejam carregados, então um plugin não pode registrar a tag tarde o suficiente para suprimir o aviso "unknown block tag" ; ela deve estar no seu typedoc.json.

Exemplo ​

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

Variáveis ​

Funções ​