realaravinth/forgejo-federation
1
0
Fork 0
Code Issues Pull requests 6 Projects Releases Packages Wiki Activity
forgejo-federation/docs
History
zeripath 82a979707a
Update documentation for the go module era (#9751) 
* Update documentation for the go module era

use go env instead of $GOPATH

Update instructions to just use git clone

Slight update to readme

Signed-off-by: Andrew Thornton <art27@cantab.net>

* fixup

* Apply suggestions from code review

Co-Authored-By: Antoine GIRARD <sapk@users.noreply.github.com>
Co-Authored-By: Bagas Sanjaya <bagasdotme@gmail.com>

* Apply suggestions from code review

* Fix GOPATH settings

Co-authored-by: Antoine GIRARD <sapk@users.noreply.github.com>
Co-authored-by: Bagas Sanjaya <bagasdotme@gmail.com>
Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
Co-authored-by: techknowlogick <techknowlogick@gitea.io>
2020-01-28 21:30:02 -05:00
..
assets/js Implement documentation search (#8937) 2019-11-13 18:03:18 +00:00
content Update documentation for the go module era (#9751) 2020-01-28 21:30:02 -05:00
layouts Implement documentation search (#8937) 2019-11-13 18:03:18 +00:00
scripts Fix building of docs with latest hugo version (#3856) 2018-04-28 23:46:05 +03:00
static Update _headers (#9349) 2019-12-13 22:03:09 +02: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 Update version in docs (#9588) 2020-01-02 17:53:08 +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 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

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

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