gitea-theme/README.md
Septatrix 0113eed132 Fix badge to use https (#82)
Update Drone link to point to new URL

Upgrade a few more http links

Fix badge to use https

Reviewed-on: gitea/theme#82
Reviewed-by: silverwind <silverwind@noreply.gitea.io>
Reviewed-by: 6543 <6543@noreply.gitea.io>
2020-01-20 02:33:30 +00:00

2.1 KiB

Gitea: Theme

Build Status Join the chat at https://img.shields.io/discord/322538954119184384.svg

This is a Hugo theme that gets used within all of our websites like our blog, documentation and also the redirects. If you commit any changes to the master branch it will trigger rebuilds of all the related websites.

Install

You need an existing Hugo website, than you can just download our prebuilt theme, put it into your themes/gitea folder and enable the theme with the theme = "gitea" option of your website.

Development

We choose npm to fetch our dependencies and gulp for the pipeline. We won't cover the installation of nodejs or npm, for that you can find enough guides depending on your operating system. First of all you have to install the required dependencies:

npm install

After you have successfully installed the required dependencies you should be able to use these commands to just clean and build generated sources of the theme:

npm run clean
npm run build
npm run release

If you want to do more development on the theme we suggest to use the watch task we have defined to get the changes directly built after saving changes to a file:

npm run watch

When you are done with your changes just create a pull request, after merging the pull request the theme will be published to our download page 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) 2019 The Gitea Authors <https://gitea.io>