pantoken / demo

demo ​

Beta

@pantoken/typedoc-plugin-demo — wtyczka TypeDoc dla znacznika bloku @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.)

Ogrodzenie przechodzi przez markdown bez zmian — włączając każdy proces tłumaczeniowy, który zachowuje bloki kodu — więc demo przetrwa lokalizację.

Konfiguracja: dodaj "@demo" do opcji blockTags TypeDoc. Parser komentarzy odczytuje tę listę zanim wczytane zostaną wtyczki, więc wtyczka nie może zarejestrować znacznika wystarczająco późno, by stłumić ostrzeżenie "nieznany znacznik bloku" — musi być w Twoim typedoc.json.

Przykład ​

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

Zmienne ​

Funkcje ​