pantoken / demo

demo ​

Beta

@pantoken/typedoc-plugin-demo — un complemento de TypeDoc para la etiqueta de bloque @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.)

El delimitador atraviesa el markdown intacto — incluyendo cualquier canal de traducción que preserve los bloques de código — así la demostración sobrevive a la localización.

Configuración: añade "@demo" a la opción blockTags de TypeDoc. El analizador de comentarios lee esa lista antes de que se carguen los plugins, por lo que un plugin no puede registrar la etiqueta lo bastante tarde como para suprimir la advertencia "etiqueta de bloque desconocida" ; debe estar en tu typedoc.json.

Ejemplo ​

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

Variables ​

Funciones ​