forked from gitea/gitea
1
0
Fork 0
gitea/docs
David Svantesson 223b9d9a64 Add 'make revive' to instructions for checking code (#8314)
* Add 'make revive' to instructions for checking code

This is performed on drone, hacking instructions should contain the same to avoid unnecessary PR builds.

* lint is deprecated. Denote revive +vet as code analysis in continuous text.
2019-09-29 23:36:52 +03:00
..
content Add 'make revive' to instructions for checking code (#8314) 2019-09-29 23:36:52 +03:00
layouts Add config option and shortcode for Gitea version (#7940) 2019-08-23 09:55:06 +08:00
scripts Fix building of docs with latest hugo version (#3856) 2018-04-28 23:46:05 +03:00
static Add oauth2 documentation (#6604) 2019-04-14 10:42:11 +02:00
.editorconfig Import docs into main repository (#2874) 2017-11-26 23:44:32 +02:00
.gitignore Swagger.v1.json template (#3572) 2018-07-28 03:19:01 +03:00
LICENSE Import docs into main repository (#2874) 2017-11-26 23:44:32 +02:00
Makefile Ensure docs makefile downloads theme if failed before. (#3322) 2018-01-07 14:11:17 +02:00
README.md Update to docs README (#6221) 2019-03-01 15:39:30 -05:00
README_ZH.md CN translation of README (#5049) 2018-10-18 09:44:29 +08:00
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>