Skip to content

Commit

Permalink
Add localization plugin to Readme.md plugin section (#850)
Browse files Browse the repository at this point in the history
Adding localization plugin in the plugin section. 

This plugin will ease every user, to:
1. Generate a json files with all code comments based on the project structure
2. Edit the json with the translation on the desired language
3. Re-generate the typodoc documentation with the updated jason for the new language
  • Loading branch information
zdrawku authored and aciccarello committed Sep 3, 2018
1 parent 820077a commit c109e8b
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Expand Up @@ -137,6 +137,7 @@ There is a plugin available to run TypeDoc with Grunt created by Bart van der Sc
* [Sourcefile URL](https://github.com/gdelmas/typedoc-plugin-sourcefile-url) - Set custom source file URL links
* [Internal/External Module](https://github.com/christopherthielen/typedoc-plugin-internal-external) - Explicitly mark modules as `@internal` or `@external`
* [Single Line Tags](https://github.com/christopherthielen/typedoc-plugin-single-line-tags) - Process certain `@tags` as single lines
* [Localization](https://github.com/IgniteUI/typedoc-plugin-localization) - Generate documentation for different languages

## Advanced guides and docs

Expand Down
1 change: 1 addition & 0 deletions src/test/renderer/specs/index.html
Expand Up @@ -182,6 +182,7 @@ <h2 id="plugins">Plugins</h2>
<li><a href="https://github.com/gdelmas/typedoc-plugin-sourcefile-url">Sourcefile URL</a> - Set custom source file URL links</li>
<li><a href="https://github.com/christopherthielen/typedoc-plugin-internal-external">Internal/External Module</a> - Explicitly mark modules as <code>@internal</code> or <code>@external</code></li>
<li><a href="https://github.com/christopherthielen/typedoc-plugin-single-line-tags">Single Line Tags</a> - Process certain <code>@tags</code> as single lines</li>
<li><a href="https://github.com/IgniteUI/typedoc-plugin-localization">Localization</a> - Generate documentation for different languages</li>
</ul>
<h2 id="advanced-guides-and-docs">Advanced guides and docs</h2>
<p>Visit our homepage for advanced guides and an extensive API documentation:<br>
Expand Down

0 comments on commit c109e8b

Please sign in to comment.