pantoken / demo

demo ​

Beta

@pantoken/typedoc-plugin-demo — @demo blok etiketi için bir TypeDoc eklentisidir.

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

Çit markdown içinde dokunulmadan ilerler — kod bloklarını koruyan herhangi bir çeviri hattı da dahil — böylece demo yerelleştirmeden sağlam çıkar.

Kurulum: "@demo" öğesini TypeDoc'un blockTags seçeneğine ekleyin. Yorum ayrıştırıcı o listeyi eklentiler yüklenmeden önce okur, bu yüzden bir eklenti etiketi "unknown block tag" uuyarısını bastıracak kadar geç kaydedemez; bu, typedoc.json içinde olmalıdır.

Örnek ​

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

Değişkenler ​

Fonksiyonlar ​