gitea/docs
2020-10-27 20:06:35 +00:00
..
assets/js Modernize docs/assets/js/search.js (#10621) 2020-03-08 21:41:52 -03:00
content Add deprecation notice for webhook payload's secret field (#13330) 2020-10-27 20:06:35 +00:00
layouts Add node version variable to docs (#10620) 2020-03-05 16:36:22 -06:00
scripts Fix building of docs with latest hugo version (#3856) 2018-04-28 23:46:05 +03:00
static Refactor docs (#13275) 2020-10-23 11:59:45 -04:00
.editorconfig Import docs into main repository (#2874) 2017-11-26 23:44:32 +02:00
.gitignore Implement documentation search (#8937) 2019-11-13 18:03:18 +00:00
config.yaml latest version is 1.12.5 (#13005) 2020-10-01 15:21:25 -04:00
LICENSE Import docs into main repository (#2874) 2017-11-26 23:44:32 +02:00
Makefile release docs as an archive (#12243) 2020-07-13 22:09:39 -04:00
README.md Update to docs README (#6221) 2019-03-01 15:39:30 -05:00
README_ZH.md update discord link (#10455) 2020-02-25 12:36:45 -05:00

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>