github-mirror/gitea
2
0
Fork 0
mirror of https://github.com/go-gitea/gitea.git synced 2024-11-24 13:53:58 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity
4a8ee0b5cc
gitea/docs
History
stevegt aaf6be3ee6 Create api-usage doc page (#4306) 
* add api user guides in doc

* update user-guides api page

* fix typo: user guides -> user guide

* move api-usage page under advanced category

* flesh out API usage docs

* Build on work by @tungsheng

* Address issues raised in #4037, #3673, and #4243

* Close #4247

Signed-off-by: Steve Traugott <stevegt@t7a.org>
2018-06-25 20:12:46 +08:00
..
content Create api-usage doc page (#4306) 2018-06-25 20:12:46 +08:00
docker French translation for docs (#3030) 2017-11-30 20:45:48 +08: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 Import docs into main repository (#2874) 2017-11-26 23:44:32 +02:00
.editorconfig Import docs into main repository (#2874) 2017-11-26 23:44:32 +02:00
.gitignore Import docs into main repository (#2874) 2017-11-26 23:44:32 +02:00
config.yaml French translation for docs (#3030) 2017-11-30 20:45:48 +08:00
Dockerfile Fix master build for docs docker (#3004) 2017-11-29 00:17:23 +02: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 Import docs into main repository (#2874) 2017-11-26 23:44:32 +02:00

README.md

Gitea: Docs

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

Hosting

This page is hosted on our infrastructure within Docker containers, it gets
automatically updated on every push to the master branch.

If you want to host this page on your own you can take our docker image
gitea/docs.

Install

This pages uses 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

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