pantoken / demo

demo ​

Béite

@pantoken/typedoc-plugin-demo — breiseán TypeDoc don lipéad 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.)

Ritheann an fál tríd an markdown gan teagmháil — lena n-áirítear aon phróiseas aistriúcháin a choimeádann bloic chód — ionas go maireann an taispeántas tar éis an áitiúcháin.

Socruithe: cuir "@demo" le rogha blockTags de TypeDoc. Léann an parsála tráchtanna an liosta sin sular lódálann na breiseáin, mar sin ní féidir le breiseán an lipéad a chlárú chomh déanach chun an foláireamh "unknown block tag" a shéanadh; caithfidh sé a bheith i do typedoc.json.

Sampla ​

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

Athróga ​

Feidhmeanna ​