mirrors
/
forgejo
mirror of
1
Fork 0
Code Issues Releases Activity
forgejo/docs
History
HesterG d2c9fb02dd
Unify doc links to use paths relative to doc folder (#24979) (#25000) 
Backport #24979 

Changes:

1. Use uniform links types relative to doc folder (start with `doc/`)
2. According to [docusaurus
links](https://docusaurus.io/docs/markdown-features/links), if `<a>` is
used, the `href` is resolved as URL location, but not file location. So
need to use `[text]({{< relref "path" >}})` instead.
 		2023-05-30 18:08:32 +08:00
..
assets/js Add new JS linter rules (#17699) 2021-11-22 16:19:01 +08:00
content Unify doc links to use paths relative to doc folder (#24979) (#25000) 2023-05-30 18:08:32 +08:00
layouts docs: move search input to navbar (#20551) 2022-08-08 15:27:04 +08:00
scripts Run hugo via `go run` and lock its version (#22206) 2022-12-21 21:09:53 -05:00
static Merge `push to create`, `open PR from push`, and `push options` docs articles into one (#23744) (#23959) 2023-04-07 15:49:26 +08:00
.gitignore Support Issue forms and PR forms (#20987) 2022-09-02 15:58:49 +08:00
LICENSE Import docs into main repository (#2874) 2017-11-26 23:44:32 +02:00
Makefile Rename develop -> development, contribute -> contributing, administer -> administration (#23662) 2023-03-23 15:44:09 -05:00
README.md Update to docs README (#6221) 2019-03-01 15:39:30 -05:00
README_ZH.md update discord link (#10455) 2020-02-25 12:36:45 -05:00
config.yaml Rename develop -> development, contribute -> contributing, administer -> administration (#23662) 2023-03-23 15:44:09 -05: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>