mirror of
https://gitea.com/gitea/docs.git
synced 2026-06-24 21:26:09 +00:00
04a97d20b1
# Changes - Added [redocusaurus](https://github.com/rohit-gohri/redocusaurus) package to display swagger api with reference to [woodpecker](https://github.com/woodpecker-ci/woodpecker/tree/master/docs) - Change `sed` for swagger.json for proper version and baseurl. - Add a dropdown for different api versions. (screenshot below) - On API pages, only API version dropdown will show(hide locale dropdown, version dropdown for doc, and doc search) - Allow build CSR API pages for development so it saves building time. # Screenshots     Search:  Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/32 Co-authored-by: HesterG <hestergong@gmail.com> Co-committed-by: HesterG <hestergong@gmail.com>
52 lines
582 B
Markdown
52 lines
582 B
Markdown
# Gitea Docusaurus
|
|
|
|
## How to build
|
|
|
|
```shell
|
|
make clean
|
|
make prepare-docs
|
|
make build
|
|
```
|
|
|
|
## Development
|
|
|
|
```shell
|
|
make clean
|
|
make prepare-docs
|
|
make serve
|
|
```
|
|
|
|
## Test en version
|
|
|
|
```
|
|
npm run start
|
|
```
|
|
|
|
## Test zh-cn version
|
|
|
|
```
|
|
npm run start -- --locale zh-cn
|
|
```
|
|
|
|
## Translate presets for zh-cn version
|
|
|
|
```
|
|
npx docusaurus write-translations --locale zh-cn
|
|
```
|
|
|
|
## Test both zh-cn and en versions
|
|
|
|
```
|
|
npm run build
|
|
npm run serve
|
|
```
|
|
|
|
## Use CSR Api
|
|
|
|
This is for development, api pages will be CSR so this saves building time
|
|
|
|
```
|
|
npm run start-CSRApi
|
|
npm run build-CSRApi
|
|
```
|