mirror of
https://gitea.com/gitea/docs.git
synced 2026-07-21 18:27:41 +00:00
20c970682b
# 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>
46 lines
1.3 KiB
YAML
46 lines
1.3 KiB
YAML
name: Build and Publish Docs site
|
|
run-name: docusaurus build docs site
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
|
|
jobs:
|
|
build-docs:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v3
|
|
- uses: https://github.com/actions/setup-node@v3
|
|
with:
|
|
node-version: 16
|
|
- name: install necessary tools
|
|
run: |
|
|
apt update -y && apt install -y rsync python python3-pip
|
|
pip install awscli
|
|
- name: prepare nightly docs
|
|
run: |
|
|
make prepare-latest
|
|
make prepare-latest-zh-cn
|
|
- name: prepare 1.19 docs
|
|
run: |
|
|
make prepare\#19
|
|
make prepare-zh-cn\#19
|
|
- name: cleanup before build
|
|
run: |
|
|
rm static/_*
|
|
- name: build site
|
|
run: |
|
|
npm ci
|
|
npm run build
|
|
- name: aws credential configure
|
|
uses: https://github.com/aws-actions/configure-aws-credentials@v1
|
|
with:
|
|
aws-access-key-id: ${{ secrets.AWS_KEY_ID }}
|
|
aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY}}
|
|
aws-region: ${{ secrets.AWS_REGION}}
|
|
- name: Copy files to the production website with the AWS CLI
|
|
run: |
|
|
aws s3 sync build/ s3://docs-gitea-com
|
|
aws cloudfront create-invalidation --distribution-id ${{ secrets.AWS_DISTRIBUTION}} --paths '/*'
|