This repository has been archived on 2024-01-04. You can view files and clone it, but cannot push or open issues or pull requests.
forgejo/docs
pseudocoder 1b8a9197b3 Add warning to docs in order to avoid template mismatches (#9411)
* DOCS: add mention of swagger api reference

It's(swagger api link) mentioned vaguely in the FAQ but IMHO missing from API usage page.

* Add warning to avoid template mismatches 

Related to https://github.com/go-gitea/gitea/issues/9320
2019-12-18 16:48:33 +01:00
..
assets/js Implement documentation search (#8937) 2019-11-13 18:03:18 +00:00
content Add warning to docs in order to avoid template mismatches (#9411) 2019-12-18 16:48:33 +01:00
layouts Implement documentation search (#8937) 2019-11-13 18:03:18 +00:00
scripts
static Update _headers (#9349) 2019-12-13 22:03:09 +02:00
.editorconfig
.gitignore Implement documentation search (#8937) 2019-11-13 18:03:18 +00:00
config.yaml docs change gitea version to 1.10.1 (#9270) 2019-12-06 14:12:38 -05:00
LICENSE
Makefile
README.md
README_ZH.md

Gitea: Docs

Join the chat at https://img.shields.io/discord/322538954119184384.svg

Hosting

These pages are hosted using netlifycms and get automatically updated on every push to the master branch.

Install

These pages use the Hugo static site generator. If you are planning to contribute you'll want to download and install Hugo on your local machine.

The installation of Hugo is out of the scope of this document, so please take the official install instructions to get Hugo up and running.

Development

To generate the website and serve it on localhost:1313 just execute this command and stop it with Ctrl+C:

make server

When you are done with your changes just create a pull request, after merging the pull request the website will be updated automatically.

Contributing

Fork -> Patch -> Push -> Pull Request

Authors

License

This project is under the Apache-2.0 License. See the LICENSE file for the full license text.

Copyright (c) 2016 The Gitea Authors <https://gitea.io>