pantoken / demo
demo
Béta
@pantoken/typedoc-plugin-demo — a TypeDoc beépülő modul a @demo blokkacímkéhez.
A szerzők élő, beágyazható bemutatót csatolnak bármely szimbólumhoz @demo <spec> segítségével, ahol <spec> vagy egy sima URL vagy egy <provider>:<ref> pár (például stackblitz:abc123, codesandbox:xy12z, wp-playground:https://…/blueprint.json vagy self:button). Ez a plugin önmagában nem regisztrál semmit a szolgáltatók közül — szándékosan marad hülye és újrahasználható: az egyes @demo tag specifikációit a szilárd szimbólum összefoglalásához hozzáfűzött kerített demo blokkba helyezi, és a dokumentáció renderere dönti el, hogyan fordítsa a specifikációt iframévé. (Lásd @pantoken/demo a szolgáltatókat feloldó rendererhez.)
A kerítés érintetlen maradt a markdown-on — beleértve bármely fordítási folyamatot, amely megőrzi a kódablokkat — így a demó túléli a honosítást.
Beállítás: adjon hozzá "@demo"-t a TypeDoc blockTags lehetőségéhez. A megjegyzéselemző azt a listát olvassa be, mielőtt a beépülő modulok betöltődnének, így egy beépülő modul nem tudja a címkét későn regisztrálni ahhoz, hogy elnyomja az "ismeretlen blokkacímke" figyelmeztetést; a typedoc.json-ben kell lennie.
Példa
// typedoc.json
{
"plugin": ["typedoc-plugin-markdown", "@pantoken/typedoc-plugin-demo"],
"blockTags": ["@param", "@returns", "@example", "@demo"]
}