mirror of
https://gitea.com/gitea/docs.git
synced 2026-03-27 14:11:03 +07: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](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:   Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/13 Co-authored-by: HesterG <hestergong@gmail.com> Co-committed-by: HesterG <hestergong@gmail.com>
45 lines
1.4 KiB
Bash
45 lines
1.4 KiB
Bash
#!/bin/bash
|
|
|
|
set -xe
|
|
|
|
if sed --version 2>/dev/null | grep -q GNU; then
|
|
SED_INPLACE="sed -i"
|
|
else
|
|
SED_INPLACE="sed -i ''"
|
|
fi
|
|
|
|
$SED_INPLACE 's/<empty/<⁠empty/' docs/administration/config-cheat-sheet.en-us.md
|
|
$SED_INPLACE 's/<empty/<⁠empty/' docs/contributing/guidelines-backend.en-us.md
|
|
$SED_INPLACE 's/</<⁠/' docs/contributing/guidelines-backend.en-us.md
|
|
$SED_INPLACE 's/</⁠/' docs/contributing/guidelines-backend.en-us.md
|
|
$SED_INPLACE 's/^url:.*//' docs/intro.md
|
|
$SED_INPLACE 's/^slug:.*/slug: \//' docs/intro.md
|
|
$SED_INPLACE 's/.\/guidelines-frontend.md/.\/guidelines-frontend/' docs/development/hacking-on-gitea.en-us.md
|
|
|
|
$SED_INPLACE 's/"version":.*/"version":"1.20-dev"/' static/latest-swagger.json
|
|
|
|
for file in `find ./docs/ -name "*.md"`; do
|
|
# hide hugo toc
|
|
$SED_INPLACE 's/{{< toc >}}//' $file
|
|
$SED_INPLACE 's/{{< version >}}/main-nightly/g' $file
|
|
$SED_INPLACE 's/{{< relref "doc/i18n\/en\/docusaurus-plugin-content-docs\/current/g' $file
|
|
$SED_INPLACE 's/" >}}//g' $file
|
|
$SED_INPLACE 's/\*\*Table of Contents\*\*//' $file
|
|
$SED_INPLACE 's/weight:/sidebar_position:/g' $file
|
|
#sed -i 's/^slug:.*//' $file
|
|
done
|
|
|
|
for file in docs/*; do
|
|
if [ -d $file ]; then
|
|
continue
|
|
fi
|
|
if [ "$file" == "docs/intro.md" ]; then
|
|
continue
|
|
fi
|
|
rm $file || true
|
|
done
|
|
|
|
for file in `find ./docs/ -name "*.en-us.md"`; do
|
|
mv "${file}" "${file/.en-us/}"
|
|
done
|