History

Jan-Eric Schober b65ad70f53 Add the possibility to allow the user to have a favicon which differs from the main logo (#18542 ) * Changed the filename of the favicon SVG This allows the user to have a favicon which differs from the logo. * Added favicon.svg This is needed to accommodate the changes for allowing the user to have a differing logo and favicon * Adjusted page to accommodate what icon is used as favicon * Added functionality to also generate the favicon.svg via generate-images.js * Adjusted the description for the new favicon compatibility Co-authored-by: silverwind <me@silverwind.io> * Updated generate-images.js to generate favicons from a separate favicons.svg file This belongs to PR #18542. * Added description on how custom favicons can be generated * Replaced space indents with tabs * Synced changes with current state of the file * Synced changes with current state of the file Co-authored-by: silverwind <me@silverwind.io> Co-authored-by: zeripath <art27@cantab.net> Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com> Co-authored-by: Lauris BH <lauris@nix.lv>		2022-05-23 23:54:48 +08:00
..
assets/js	Add new JS linter rules (#17699 )	2021-11-22 16:19:01 +08:00
content	Add the possibility to allow the user to have a favicon which differs from the main logo (#18542 )	2022-05-23 23:54:48 +08:00
layouts	Add node version variable to docs (#10620 )	2020-03-05 16:36:22 -06:00
scripts	Fix building of docs with latest hugo version (#3856 )	2018-04-28 23:46:05 +03:00
static	Self-host cloudron image for docs (#13895 )	2020-12-07 22:20:37 -05:00
.gitignore	Implement documentation search (#8937 )	2019-11-13 18:03:18 +00:00
config.yaml	Add changelog for v1.16.8 (#19724 ) (#19730 )	2022-05-16 17:01:13 -04:00
LICENSE
Makefile	follow redirect when fetching theme archive (#15986 )	2021-05-26 18:03:39 -04: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

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>