pantoken / demo

demo ​

بيتا

@pantoken/typedoc-plugin-demo — ملحق TypeDoc لوسم الكتلة @demo.

يضيف المؤلفون عرضًا توضيحيًا حيًا قابلاً للتضمين إلى أي رمز باستخدام @demo <spec>، حيث يكون <spec> إما عنوان URL عادي أو زوج <provider>:<ref> (على سبيل المثال stackblitz:abc123, codesandbox:xy12z, wp-playground:https://…/blueprint.json, أو self:button). هذا الملحق لا يسجل أي معلومات عن المزوّدين بنفسه — يبقى متعمدًا بسيطًا وقابلًا لإعادة الاستخدام: ينقل مواصفة كل وسم @demo إلى كتلة demo محاطة بأسوار وتُضاف إلى ملخص الرمز، ويقرر مُعالج الوثائق الخاص بك كيفية تحويل المواصفة إلى iframe. (انظر @pantoken/demo لعارض (renderer) يقوم بحل المزودين.)

يمر الحاجز عبر markdown دون تغيير — بما في ذلك أي خط أنابيب ترجمة يحافظ على كتل التعليمات البرمجية — لذا يظل العرض التوضيحي صالحًا بعد التوطين.

الإعداد: أضف "@demo" إلى خيار blockTags في TypeDoc. يقرأ محلل التعليقات تلك القائمة قبل تحميل الإضافات، لذلك لا يمكن للإضافة أن تسجل الوسم في وقت متأخر بما يكفي لقمع تحذير "unknown block tag" ؛ يجب أن يكون في typedoc.json لديك.

مثال ​

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

المتغيرات ​

الدوال ​