History

wxiaoguang faa28b5a44 Move public asset files to the proper directory (#25907 ) Move `public/` to `public/assets/` Some old PRs (like #15219) introduced inconsistent directory system. For example: why the local directory "public" is accessed by `http://site/assets`? How to serve the ".well-known" files properly in the public directory? For convention rules, the "public" directory is widely used for the website's root directory. It shouldn't be an exception for Gitea. So, this PR makes the things consistent: * `http://site/assets/foo` means `{CustomPath}/public/assets/foo`. * `{CustomPath}/public/.well-known` and `{CustomPath}/public/robots.txt` can be used in the future. This PR is also a prerequisite for a clear solution for: * #21942 * #25892 * discourse.gitea.io: [.well-known path serving custom files behind proxy?](https://discourse.gitea.io/t/well-known-path-serving-custom-files-behind-proxy/5445/1) This PR is breaking for users who have custom "public" files (CSS/JS). After getting approvals, I will update the documents. ---- ## ⚠️ BREAKING ⚠️ If you have files in your "custom/public/" folder, please move them to "custom/public/assets/". --------- Co-authored-by: 6543 <6543@obermui.de> Co-authored-by: Giteabot <teabot@gitea.io>		2023-07-18 18:06:43 +02:00
..
assets/js	Update JS dependencies, add new eslint rules (#24597 )	2023-05-09 02:35:49 +00:00
content	Move public asset files to the proper directory (#25907 )	2023-07-18 18:06:43 +02:00
layouts	Remove meta charset from HTML5 documents (#24744 )	2023-05-16 05:13:23 +00:00
scripts
static	Docs for Gitea Actions (#24405 )	2023-05-05 20:07:20 +00:00
.gitignore
config.yaml	Use Go 1.20 for next release (#24859 )	2023-05-22 16:29:53 +00:00
LICENSE
Makefile	Restructure documentation. Now the documentation has installation, administration, usage, development, contributing the 5 main parts (#23629 )	2023-03-23 23:18:24 +08:00
README_ZH.md
README.md

README.md

Gitea: Docs

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>