diff options
author | 6543 <6543@obermui.de> | 2020-12-08 04:52:26 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-12-07 23:52:26 -0500 |
commit | 6bdcacd73b403354aa180bfada7236038d9712b1 (patch) | |
tree | 831f00e67434304c75561df0f163b1ca51c5c157 /docs/content/doc/developers | |
parent | e7938c9c44384e044afba14d5a86b1ba32520dd3 (diff) | |
download | gitea-6bdcacd73b403354aa180bfada7236038d9712b1.tar.gz gitea-6bdcacd73b403354aa180bfada7236038d9712b1.zip |
Added Table of Contents to long documentation pages (#13890)
* Redo #13836 with new shortcode
(https://gitea.com/gitea/theme/pulls/90)
* add Api Usage
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
Diffstat (limited to 'docs/content/doc/developers')
-rw-r--r-- | docs/content/doc/developers/api-usage.en-us.md | 8 | ||||
-rw-r--r-- | docs/content/doc/developers/hacking-on-gitea.en-us.md | 6 |
2 files changed, 9 insertions, 5 deletions
diff --git a/docs/content/doc/developers/api-usage.en-us.md b/docs/content/doc/developers/api-usage.en-us.md index 5e979d1e94..7dc6406a23 100644 --- a/docs/content/doc/developers/api-usage.en-us.md +++ b/docs/content/doc/developers/api-usage.en-us.md @@ -13,7 +13,9 @@ menu: identifier: "api-usage" --- -# Gitea API Usage +# API Usage + +{{< toc >}} ## Enabling/configuring API access @@ -22,7 +24,7 @@ By default, `ENABLE_SWAGGER` is true, and Sheet](https://docs.gitea.io/en-us/config-cheat-sheet/) for more information. -## Authentication via the API +## Authentication Gitea supports these methods of API authentication: @@ -39,7 +41,7 @@ Gitea parses queries and headers to find the token in You can create an API key token via your Gitea installation's web interface: `Settings | Applications | Generate New Token`. -### OAuth2 +## OAuth2 Provider Access tokens obtained from Gitea's [OAuth2 provider](https://docs.gitea.io/en-us/oauth2-provider) are accepted by these methods: diff --git a/docs/content/doc/developers/hacking-on-gitea.en-us.md b/docs/content/doc/developers/hacking-on-gitea.en-us.md index 6eda456ce2..2c331faf63 100644 --- a/docs/content/doc/developers/hacking-on-gitea.en-us.md +++ b/docs/content/doc/developers/hacking-on-gitea.en-us.md @@ -15,6 +15,8 @@ menu: # Hacking on Gitea +{{< toc >}} + ## Installing go You should [install go](https://golang.org/doc/install) and set up your go @@ -42,7 +44,7 @@ running. As of last update, it should be Go version {{< go-version >}}. Gitea makes heavy use of Make to automate tasks and improve development. This guide covers how to install Make. -#### On Linux +### On Linux Install with the package manager. @@ -58,7 +60,7 @@ On Fedora/RHEL/CentOS: sudo yum install make ``` -#### On Windows +### On Windows One of these three distributions of Make will run on Windows: |