pantoken / demo

demo ​

बीटा

@pantoken/typedoc-plugin-demo — @demo ब्लॉक टैग के लिए एक TypeDoc प्लगइन।

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

फेंस मार्कडाउन के माध्यम से बिना छुए चलता है — उन किसी भी अनुवाद पाइपलाइन सहित जो कोड ब्लॉक्स को संरक्षित करती हैं — इसलिए डेमो स्थानीयकरण में जीवित रहता है।

सेटअप: "@demo" को TypeDoc के blockTags विकल्प में जोड़ें। टिप्पणी पार्सर उस सूची को प्लगइन्स लोड होने से पहले पढ़ता है, इसलिए कोई प्लगइन टैग को इतना देर से रजिस्टर नहीं कर सकता कि "अज्ञात ब्लॉक टैग" चेतावनी दब जाए; यह आपके typedoc.json में होना चाहिए।

उदाहरण ​

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

वैरिएबल्स ​

फंक्शन्स ​