Commit Graph

14 Commits

Author SHA1 Message Date
b9e0a85c9b Use a formal docusaurus i18n structure 2024-06-06 20:44:06 +08:00
089f2a0b46 Make the index page default 2024-06-06 17:10:46 +08:00
20c970682b Add Chinese support (#13)
# 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)

Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/13
Co-authored-by: HesterG <hestergong@gmail.com>
Co-committed-by: HesterG <hestergong@gmail.com>
2023-05-26 14:30:13 +08:00
fd424b0f6c fix duplicate packages and actions 2023-05-18 14:37:43 +08:00
e45d486281 Update sidebars.js 2023-05-16 09:45:02 +08:00
07221f40eb update path 2023-05-16 03:22:14 +08:00
fd1ea75872 update path 2023-05-12 15:53:33 -04:00
c75d40862a update dir name 2023-05-12 15:50:27 -04:00
5823cf05e8 remove unnecessary comma 2023-05-09 09:49:53 +08:00
dbd1986910 upgrade to 1.19.3 2023-05-08 22:32:15 +08:00
da0e55515b Fix multiple languages sidebar 2023-04-04 12:14:20 +08:00
3df69c5b21 Test multiple levels siderbar 2023-03-25 13:46:36 +08:00
1116d1e72d Update structures for 1.19 and current version 2023-03-24 13:10:55 +08:00
d92b99e395 first commit 2023-02-02 23:30:20 -05:00