gitea/gitea-docs
1
0
Fork 0
mirror of https://gitea.com/gitea/docs.git synced 2026-06-28 15:14:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add api page (#32)

Browse Source 
# 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

![Screen Shot 2023-06-27 at 11.56.59](/attachments/7f43976d-f9f1-42ff-85f5-0bc84e549441)

![Screen Shot 2023-06-27 at 10.58.11](/attachments/bde25da5-b0a6-4908-9c69-c6aed41f8f59)

![Screen Shot 2023-06-21 at 12.26.26](/attachments/84a9bf5a-229b-4031-9654-3bae6cb3301a)

![Screen Shot 2023-06-19 at 16.34.33](/attachments/653b2b59-bc8a-4e6c-82f2-eb9710f55d8d)

Search:

![Screen Shot 2023-06-21 at 14.49.15](/attachments/3a09bd89-36a8-4156-a2df-2d3176d3ddb1)

Reviewed-on: https://gitea.com/gitea/gitea-docusaurus/pulls/32
Co-authored-by: HesterG <hestergong@gmail.com>
Co-committed-by: HesterG <hestergong@gmail.com>
This commit is contained in:
HesterG
2023-07-05 03:54:54 +00:00
committed by Lunny Xiao
parent a6ca489269
commit 04a97d20b1
14 changed files with 2069 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
loop_docs.sh
View File

@@ -15,7 +15,7 @@ SED_INPLACE() {
}
version="$1"
if [ "$version" != "lastest" ]; then
if [ "$version" != "latest" ]; then
version="1.$1"
fi
locale="$2"
@@ -31,7 +31,7 @@ elif ["$version" == "1.20"]; then
fi
docs_dir="versioned_docs/version-$version"
if [ "$version" == "lastest" ]; then
if [ "$version" == "latest" ]; then
if [ "$locale" == "en-us" ]; then
docs_dir="docs"
else
@@ -58,13 +58,14 @@ SED_INPLACE "s/{{< min-go-version >}}/$minGoVer/" "$docs_dir/installation/from-s
# TODO: improve this sed
# need confirmation
if [ "$version" == "lastest" ]; then
SED_INPLACE 's/"version":.*/"version":"1.21-dev"/' static/latest-swagger.json
if [ "$version" == "latest" ]; then
SED_INPLACE 's/"version": "{{AppVer | JSEscape | Safe}}"/"version": "1.21-dev"/' static/swagger-latest.json
elif [ "$version" == "1.20" ]; then
SED_INPLACE 's/"version":.*/"version":"1.20.0-rc2"/' static/20-swagger.json
SED_INPLACE 's/"version": "{{AppVer | JSEscape | Safe}}"/"version": "1.20.0-rc2"/' static/swagger-20.json
elif [ "$version" == "1.19" ]; then
SED_INPLACE 's/"version":.*/"version":"1.19.3"/' static/19-swagger.json
SED_INPLACE 's/"version": "{{AppVer | JSEscape | Safe}}"/"version": "1.19.3"/' static/swagger-19.json
fi
SED_INPLACE 's/"basePath": "{{AppSubUrl | JSEscape | Safe}}/"basePath": "https:\/\/gitea.com/' static/swagger-"$1".json
for file in `find ./"$docs_dir" -name "*.md"`; do
# hide hugo toc