gitea/theme
Archived
44
15
Fork 12
Code Issues 2 Pull Requests Actions Releases Wiki Activity
This repository has been archived on 2023-07-20. You can view files and clone it, but cannot push or open issues or pull requests.
theme/README.md
pat-s 576e8a137f
All checks were successful
continuous-integration/drone/push Build is passing
Details
Update dev instructions (#98) 
- Format markdown (one sentence per line & some more lints)
- Update dev instructions (hopefully simplifying them)

fix #96

Co-authored-by: pat-s <patrick.schratz@gmail.com>
Reviewed-on: #98
Reviewed-by: 6543 <6543@obermui.de>
Reviewed-by: Alexey 〒erentyev <axifive@noreply.gitea.io>
Co-authored-by: pat-s <pat-s@noreply.gitea.io>
Co-committed-by: pat-s <pat-s@noreply.gitea.io>
2021-09-13 01:08:33 +08:00

2.3 KiB
Raw Permalink Blame History

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

If you want to do theme development 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

Whenever you make a change to src/main.scss and save the file, this will trigger a rebuild of static/styles/main.css. To see a preview of your changes on the website, do the following:

  1. Go to gitea.io
  2. Open the developer tools
  3. Click the "Sources" tab
  4. Open the gitea.io/styles/main.css file
  5. Paste the entire main.css file from your local gitea/theme repo where npm run watch is running on

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

Copyright (c) 2019 The Gitea Authors <https://gitea.io>