diff options
| author | Lunny Xiao <xiaolunwen@gmail.com> | 2023-03-23 23:18:24 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-03-23 23:18:24 +0800 |
| commit | e8433b7fe6dd1dfa5ecf0633568cc3e34caeb0f9 (patch) | |
| tree | de72ccf6dda7170f4d8cbd3338294ba4b0ae2ecd /docs/config.yaml | |
| parent | df411819ebe4d3e6852997ce41fadf837d5d4ea0 (diff) | |
| download | gitea-e8433b7fe6dd1dfa5ecf0633568cc3e34caeb0f9.tar.gz gitea-e8433b7fe6dd1dfa5ecf0633568cc3e34caeb0f9.zip | |
Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629)
- **Installation**: includes how to install Gitea and related other
tools, also includes upgrade Gitea
- **Administration**: includes how to configure Gitea, customize Gitea
and manage Gitea instance out of Gitea admin UI
- **Usage**: includes how to use Gitea's functionalities. A sub
documentation is about packages, in future we could also include CI/CD
and others.
- **Development**: includes how to integrate with Gitea's API, how to
develop new features within Gitea
- **Contributing**: includes how to contribute code to Gitea
repositories.
After this is merged, I think we can have a sub-documentation of `Usage`
part named `Actions` to describe how to use Gitea actions
---------
Co-authored-by: John Olheiser <john.olheiser@gmail.com>
Diffstat (limited to 'docs/config.yaml')
| -rw-r--r-- | docs/config.yaml | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/config.yaml b/docs/config.yaml index 26f096b1cf..fbc4bc9a98 100644 --- a/docs/config.yaml +++ b/docs/config.yaml @@ -26,6 +26,11 @@ params: repo: "https://github.com/go-gitea/gitea" docContentPath: "docs/content" +markup: + tableOfContents: + startLevel: 1 + endLevel: 9 + outputs: home: - HTML |