typedoc-plugin-deno

This plugin is used by Deno Api Simplified Chinese Site.

This plugin allows specific typedoc @*_i18n to be processed as multi-language.

Example:

/** This comment _supports_ [Markdown](https://marked.js.org/).
 *
 * @i18n 这是一个中文注释，_支持_ [Markdown](https://marked.js.org/)。
 *
 * @param text  Comment for parameter ´text´.
 * @param_i18n text  参数 ´text´ 的中文注释。
 */
function doSomething(target: any, text: string): number;

By default, this plugin processes the following tags:

• @i18n
• @param_i18n
• @typeParam_i18n
• @returns_i18n
• @event_i18n need help

Installing

Typedoc has the ability to discover and auto-load typedoc plugins found in node_modules.

npm install --save typedoc-plugin-deno

License

typedoc-plugin-deno is released under the MIT License. See the bundled LICENSE file for details.