[FEATURE] Do you have a plan for the internationalization ?

[charlee2025]

I am from china,I want a doc use zh_cn. Do you have a plan for the internationalization ?

[vogloblinsky]

Hi, i can implement the codebase for that, and you can do a PR for the translations ?

[charlee2025]

Ok，thank you，I'll do that.

[vogloblinsky]

@lichangfeng Codebase is ready for i18n
You can do a PR by adding your locale in ./src/locales folder

[charlee2025]

@vogloblinsky Hi~
How can I use it when I add a locale file as zh_CN? Is it a command param of compodoc?

[vogloblinsky]

yes there is a new flag —language

• clone the repository
• npm i inside
• npm link
  you should have compodoc available globally
• add your locale inside src/locales, name it TRANSLATION_ZH_CN
• reference it inside the barrel file src/locales/index.ts
• edit the src/app/engines/i18n.engine.ts
• add this kind of line for your locale : i18next.addResources('zh_CN', 'translation', TRANSLATION_ZH_CN);
• and import the TRANSLATION_ZH_CN constant from locales folder

[charlee2025]

@vogloblinsky I did it, but when I run:
compodoc ./src -d ./compodoc -p tsconfig.json --theme stripe --hideGenerator --disableSourceCode --disableTemplateTab --disableDomTree --language=zh_CN
it not works.

[vogloblinsky]

Oh sorry, i miss a step :

• run npm start after the npm install, it will compile the CLI localy

[charlee2025]

@vogloblinsky ,it still not work, I try npm start and npm build.

[charlee2025]

@vogloblinsky , I run the cmd in another project:
compodoc ./src -d ./compodoc -p tsconfig.json --theme stripe --hideGenerator --disableSourceCode --disableTemplateTab --disableDomTree --language=zh_CN

[vogloblinsky]

After your npm start you should have this :

> @compodoc/compodoc@1.1.3 start /home/vogloblinsky-local/Documents/www/TMP/compodoc/compodoc
> npm run test:watch


> @compodoc/compodoc@1.1.3 test:watch /home/vogloblinsky-local/Documents/www/TMP/compodoc/compodoc
> npm-watch

No task specified. Will go through all possible tasks
[nodemon] 1.18.3
[nodemon] to restart at any time, enter `rs`
[nodemon] watching: src/**/*.ts
[nodemon] starting `npm run -s build`

./src/index-cli.ts → dist/index-cli.js...
created dist/index-cli.js in 3.3s

./src/index.ts → dist/index.js...
created dist/index.js in 3.2s
[nodemon] clean exit - waiting for changes before restart

[vogloblinsky]

If you prefer, do you PR with the locale, i will fix it, and after you could test it.

[charlee2025]

@vogloblinsky Yes, I have done a PR with the locale.

[charlee2025]

@vogloblinsky , Ok , thank you , it works right now when I close my safe software.

[vogloblinsky]

Cool i have cleaning and adding a control on the requested language with the flag.
Release tonight 1.1.4 if all is fine.

[charlee2025]

@vogloblinsky , I will create another PR to complete zh_CN.ts.

[lock]

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem. Why locking ? Having issues with the most up-to-date context.