pantoken / demo

demo ​

Beta

@pantoken/typedoc-plugin-demo — et TypeDoc-plugin for @demo-blok-tagget.

Forfattere knytter en live, indlejrbar demo til ethvert symbol med @demo <spec>, hvor <spec> enten er en nøgen URL eller et <provider>:<ref>-par (for eksempel stackblitz:abc123, codesandbox:xy12z, wp-playground:https://…/blueprint.json eller self:button). Dette plugin registrerer intet om udbydere selv — det forbliver bevidst simpelt og genbrugelig: det flytter hver @demo-tags specifikation til et hegnede demo-blok tilføjet til symbolets sammenfattelse, og din dokumentations-renderer bestemmer hvordan en specifikation bliver til en iframe. (Se @pantoken/demo for en renderer, der løser udbyderene.)

Hegnet passerer gennem markdown uberørt — herunder enhver oversættelsespipeline, der bevarer kodeblokke — så demoen overlever lokalisering.

Opsætning: Tilføj "@demo" til TypeDocs blockTags-indstilling. Kommentarparseren læser den liste før plugin'er indlæses, så et plugin kan ikke registrere tagget sent nok til at undertrykke "unknown block tag"-advarselen; det skal være i din typedoc.json.

Eksempel ​

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

Variabler ​

Funktioner ​