https://github.com/denodev/typedoc-plugin-deno
TypeDoc plugin for Deno Api Simplified Chinese
https://github.com/denodev/typedoc-plugin-deno
deno typedoc typedoc-plugin typescript
Last synced: 2 months ago
JSON representation
TypeDoc plugin for Deno Api Simplified Chinese
- Host: GitHub
- URL: https://github.com/denodev/typedoc-plugin-deno
- Owner: denodev
- License: mit
- Created: 2020-04-17T07:34:55.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-19T00:26:05.000Z (8 months ago)
- Last Synced: 2025-04-25T06:06:23.392Z (2 months ago)
- Topics: deno, typedoc, typedoc-plugin, typescript
- Language: TypeScript
- Homepage:
- Size: 42 KB
- Stars: 12
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# typedoc-plugin-deno
[](https://github.com/denodev/typedoc-plugin-deno/actions)
[](https://github.com/denodev/typedoc-plugin-deno/blob/master/LICENSE)
[](https://www.npmjs.com/package/typedoc-plugin-deno)This plugin is used by [Deno Api Simplified Chinese Site](https://github.com/denodev/typedoc).
This plugin allows specific typedoc `@*_i18n` to be processed as multi-language.
Example:
```ts
/** 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:
- [x] `@i18n`
- [x] `@param_i18n`
- [x] `@typeParam_i18n`
- [x] `@returns_i18n`
- [ ] `@event_i18n` need help### Installing
Typedoc has the ability to discover and auto-load typedoc plugins found in node_modules.
```bash
npm install --save typedoc-plugin-deno
```### License
typedoc-plugin-deno is released under the MIT License. See the bundled [LICENSE](./LICENSE) file for details.