pantoken / demo

demo ​

Beta

@pantoken/typedoc-plugin-demo — plugin TypeDoc untuk tag blok @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.)

Pembatas melalui markdown tanpa diubah — termasuk mana-mana saluran terjemahan yang mengekalkan blok kod — jadi demo kekal semasa pelokalan.

Persediaan: tambahkan "@demo" kepada pilihan blockTags TypeDoc. Pengurai komen membaca senarai itu sebelum plugin dimuatkan, jadi plugin tidak boleh mendaftar tag itu terlalu lewat untuk menekan amaran "tag blok tidak dikenali"; ia mesti berada dalam typedoc.json anda.

Contoh ​

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

Pembolehubah ​

Fungsi ​