I tried to find documentation for supporting multiple languages with no success. Is localization supported for documentation generation?
zdrawku
All 5 comments
Sorry, currently localization is not supported. I think this is out of scope for the time being so I'll close this issue but feel free to continue discussing your ideas here.
aciccarello
on 2 Aug 2018
This is the solution to my question. We have created a typedoc plugin which is:
- Merging all code comments (classes, methods, properties, enumerations etc.) that needs localization in a couple of json files.
- Translate them by hand and save your changes.
- Use the updated files to build a documentation for an entire project in the desired language.
In the Readme.md you can find more detailed explanation of the steps that you should take to use the plugin.
zdrawku
on 27 Aug 2018
Very cool! Do you want to add that to the typedoc readme?
aciccarello
on 27 Aug 2018
That would be great! If there is something that we need to consider as a plugin requirements or repository configuration, just let me know.
zdrawku
on 27 Aug 2018
Sharing with the community steps and a video representation of the localization plugin usage:
npm install typedoc-plugin-localization
npx typedoc projects\igniteui-angular\src\public_api.ts --generate-json exports
npx typedoc .\projects\igniteui-angular\src\public_api.ts --generate-from-json .\exports\ --out localized
For more information, have a look at the readme.md file.
zdrawku
on 29 Aug 2018
Related issues
Rycochet
路
4Comments
unsafecode
路
4Comments
atomsoftwarestudios
路
4Comments
Bibliofile
路
3Comments
nidsharm
路
3Comments
Most helpful comment
Very cool! Do you want to add that to the typedoc readme?