node package manager


A plugin for jsdoc to handle i18n translations

JsDoc i18n Plugin

JsDoc i18n plugin is to provide i18n translates for jsdocs.


Install with npm:

npm install jsdoc-i18n-plugin --save


Add following config into your jsdoc.config.json:

    "plugins": [
    "i18n": {
       "locale": "<en_US|zh_CN|...>", 
       "directory": "/path/to/put/your/translation/files/default/is/locales/in/working/directory",
       "srcDir": "/base/src/directory/to/build/tree/structure/for/source/files/default/is/current/directory",
       "extension": ".js" // or using .json instead. 

Then you can run jsdoc command, this plugin will automatically generate json files for specific locale. You can do translation work based on that file. The file will look like following:

    "Hello": "Hello",
    "weekend": "weekend",
    "tree": "tree"