pantoken / demo

demo ​

Бета

@pantoken/typedoc-plugin-demo — плагин TypeDoc для блочного тега @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.)

Ограждённый блок проходит через markdown нетронутым — включая любые конвейеры перевода, сохраняющие блоки кода — поэтому демонстрация переживает локализацию.

Настройка: добавьте "@demo" в опцию blockTags TypeDoc. Парсер комментариев читает этот список до загрузки плагинов, поэтому плагин не может зарегистрировать тег достаточно поздно, чтобы подавить предупреждение "неизвестный блочный тег" ; он должен находиться в вашем typedoc.json.

Пример ​

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

Переменные ​

Функции ​