pantoken / demo

demo ​

Bêta

@pantoken/typedoc-plugin-demo — un plugin TypeDoc pour la balise de bloc @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.)

Le délimiteur passe à travers le markdown sans être modifié — y compris tout pipeline de traduction qui préserve les blocs de code — donc la démo survit à la localisation.

Configuration : ajoutez "@demo" à l'option blockTags de TypeDoc. Le parseur de commentaires lit cette liste avant le chargement des plugins, donc un plugin ne peut pas enregistrer la balise assez tard pour supprimer l'avertissement "balise de bloc inconnue" ; elle doit se trouver dans votre typedoc.json.

Exemple ​

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

Variables ​

Fonctions ​