githaven/docs
Yarden Shoham b474730cf6
Refactor Gitpod configuration to improve quick spin up of automated dev environments (#21411)
This commit instructs Gitpod to run `docs` in watch mode in fresh
development environments so any dev could start hacking in seconds.

Also included some vscode extensions for Vue, Go, and Docker.


Try it here:

[![Open in
Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/yardenshoham/gitea/tree/gitpod)

Signed-off-by: Yarden Shoham <hrsi88@gmail.com>
Co-authored-by: Gusted <williamzijl7@hotmail.com>
2022-10-12 12:17:04 -04:00
..
assets/js Add new JS linter rules (#17699) 2021-11-22 16:19:01 +08:00
content Refactor Gitpod configuration to improve quick spin up of automated dev environments (#21411) 2022-10-12 12:17:04 -04:00
layouts docs: move search input to navbar (#20551) 2022-08-08 15:27:04 +08:00
scripts Fix building of docs with latest hugo version (#3856) 2018-04-28 23:46:05 +03:00
static Add redirect of /upgrade/ to /upgrade-from-gitea/ on docs site (#21330) 2022-10-06 21:53:02 +01:00
.gitignore Support Issue forms and PR forms (#20987) 2022-09-02 15:58:49 +08:00
config.yaml update current stable version 2022-08-21 22:14:13 -04:00
LICENSE Import docs into main repository (#2874) 2017-11-26 23:44:32 +02:00
Makefile follow redirect when fetching theme archive (#15986) 2021-05-26 18:03:39 -04:00
README_ZH.md update discord link (#10455) 2020-02-25 12:36:45 -05: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>