githaven-fork/docs
zeripath e55c874dd2 Add work path CLI option (#6922)
Makes it possible to set the work path as a CLI option instead of
relying on environment variables which are somewhat opaque
2019-05-14 11:20:35 -04:00
..
content Add work path CLI option (#6922) 2019-05-14 11:20:35 -04:00
layouts Import docs into main repository (#2874) 2017-11-26 23:44:32 +02: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
config.yaml Enabled emoji in Hugo (#6521) 2019-04-05 18:01:38 +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_ZH.md CN translation of README (#5049) 2018-10-18 09:44:29 +08:00
README.md Update to docs README (#6221) 2019-03-01 15:39:30 -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>