gitea/docs
pseudocoder eac5a8be75 DOCS: add mention of swagger api reference (#8452)
It's(swagger api link) mentioned vaguely in the FAQ but IMHO missing from API usage page.
2019-10-10 08:42:01 -04:00
..
content DOCS: add mention of swagger api reference (#8452) 2019-10-10 08:42:01 -04:00
layouts Add config option and shortcode for Gitea version (#7940) 2019-08-23 09:55:06 +08:00
scripts
static Add oauth2 documentation (#6604) 2019-04-14 10:42:11 +02:00
.editorconfig
.gitignore
LICENSE
Makefile
README.md Update to docs README (#6221) 2019-03-01 15:39:30 -05:00
README_ZH.md
config.yaml update docs to latest version (#8164) 2019-09-12 13:23:39 -04:00

README.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>