Add Chinese support #13

HesterG · 2023-05-24T10:44:04Z

HesterG commented

2023-05-24 10:44:04 +00:00

Main changes and Some notices

Chines Docs should be put into corresponding versions' folders under i18n/zh-cn/docusaurus-plugin-content-docs. See translate-markdown-files for reference. And also srs-docs is a project that can be used as a reference. So changed the related paths in loop_docs* scripts.
The markdown files under docs/<version> and i18n/zh-cn/docusaurus-plugin-content-docs/<version> must have the same name to be referred as translated. Files inside docs are corresponding to current version.
For example, docs/administration/mail-templates.md and i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/mail-templates.md. Filename of mail-templates.md must be the same (cannot be mail-templates.zh-cn.md and mail-templates.us-en.md)
So trim the .en-us.md and .zh-cn.md to .md to ensure the same names inside loop_docs* scripts.
Used npx docusaurus write-translations --locale zh-cn to do sidebar, footer, and header translations, so no need to keep sideBarCN anymore. reference

Local Tests for en and zh-cn are separeted, run the following on local respectly to test them

# test en version
npm run start
# test zh-cn version
npm run start -- --locale zh-cn

If wants to test en and zh-cn both at the same time, run build and serve
```
npm run build
npm run serve
```
Added some indexed page, for example:

# Main changes and Some notices - Chines Docs should be put into corresponding versions' folders under `i18n/zh-cn/docusaurus-plugin-content-docs`. See [translate-markdown-files](https://docusaurus.io/docs/i18n/tutorial#translate-markdown-files) for reference. And also [srs-docs](https://github.com/ossrs/srs-docs) is a project that can be used as a reference. So changed the related paths in `loop_docs*` scripts. - The markdown files under `docs/<version>` and `i18n/zh-cn/docusaurus-plugin-content-docs/<version>` must have the same name to be referred as translated. Files inside docs are corresponding to `current` version. For example, `docs/administration/mail-templates.md` and `i18n/zh-cn/docusaurus-plugin-content-docs/current/administration/mail-templates.md`. Filename of `mail-templates.md` must be the same (cannot be `mail-templates.zh-cn.md` and `mail-templates.us-en.md`) So trim the `.en-us.md` and `.zh-cn.md` to `.md` to ensure the same names inside `loop_docs*` scripts. - Used `npx docusaurus write-translations --locale zh-cn` to do sidebar, footer, and header translations, so no need to keep `sideBarCN` anymore. [reference](https://docusaurus.io/docs/cli#docusaurus-write-translations-sitedir) - Local Tests for `en` and `zh-cn` are separeted, run the following on local respectly to test them ```bash # test en version npm run start # test zh-cn version npm run start -- --locale zh-cn ``` - If wants to test `en` and `zh-cn` both at the same time, run build and serve ``` npm run build npm run serve ``` - Added some indexed page, for example: ![Screen Shot 2023-05-26 at 13.49.34](/attachments/9eeb3d38-c309-457d-9015-053b9c5ca8d6) ![Screen Shot 2023-05-26 at 13.49.49](/attachments/fc348d17-ce4c-4c4d-9240-b69add4ef06e)

Screen Shot 2023-05-26 at 13.49.34.png

472 KiB

Screen Shot 2023-05-26 at 13.49.49.png

414 KiB

👍 1

HesterG added 1 commit 2023-05-24 10:44:05 +00:00

add Chinese support bc2cb5e44e

lunny referenced this pull request

2023-05-25 00:32:21 +00:00

Enable Simple Chinese #5

HesterG added 1 commit 2023-05-25 01:55:28 +00:00

Merge branch 'main' into add-chinese-support 43772c59bd