document & simplify deployment as gitea theme

This commit is contained in:
Norwin Roosen 2021-07-30 12:10:03 +02:00
parent f7470d5940
commit c1e5924f90
No known key found for this signature in database
GPG key ID: 24BC059DE24C43A3
4 changed files with 25 additions and 12 deletions

View file

@ -4,17 +4,30 @@
This style changes the layout of Gitea, and uses Gitea's color variables. It can be used with any theme that changes only colors.
Using
[`Gitea-modern.css`](Gitea-modern.css)
requires a preprocessor that supports CSS nesting, like 'Stylus' (recommended) or 'Less'.
Or you can use the already compiled version,
[`Gitea-modern-compiled.css`](Gitea-modern-compiled.css)
instead.
When making contributions, don't use the compiled version.
I've never hosted a Gitea instance before so I have no idea how to apply it.
If you use the Stylus browser extension, you can use the [`Gitea-modern.user.css`](https://codeberg.org/Freeplay/CSS-Styles/raw/branch/main/Gitea/Gitea-modern.user.css) file instead to apply to any Gitea instance.
### Disclaimer
**I don't know if everything is properly polished, and the style is still being worked on. If you find an issue with the style, please create an issue. Or if you can fix an issue yourself, create a pull request!**
### Usage as Gitea theme
To install the theme for all Gitea users:
1. Download the [`theme-gitea-modern.css` file][theme-file] and add it to your custom folder in `$GITEA_CUSTOM/public/css/` ([learn how to find that directory][doc-dir]).
- The path has changed in Gitea 1.15, there the file needs to be placed in `$GITEA_CUSTOM/public/assets/css`
2. Adapt your `app.ini` to make it the default theme or be user-selectable:
- To change the default theme, change the value of `DEFAULT_THEME` in the [ui section][doc-config] of `app.ini` to `gitea-modern`
- To make a theme selectable by users in their profile settings, append `,gitea-modern` to the list of `THEMES` in your `app.ini`.
3. Restart Gitea
4. Enjoy :)
### Usage with Stylus
If you use the Stylus browser extension, you can use the [`theme-gitea-modern.user.css`][usertheme-file]) file to apply to any Gitea instance.
### Contributing
To make changes, always base them on [`theme-gitea-modern.less`](theme-gitea-modern.less), which is written for any CSS preprocessor that supports CSS nesting, like 'Stylus' (recommended) or 'Less'.
When making contributions, don't use the compiled version for your changes.
[theme-file]: https://codeberg.org/Freeplay/CSS-Styles/raw/branch/main/Gitea/theme-gitea-modern.css
[usertheme-file]: https://codeberg.org/Freeplay/CSS-Styles/raw/branch/main/Gitea/theme-gitea-modern.user.css
[doc-config]: https://docs.gitea.io/en-us/config-cheat-sheet/#ui-ui
[doc-dir]: https://docs.gitea.io/en-us/faq/#where-does-gitea-store-what-file

View file

@ -28,5 +28,5 @@
@-moz-document domain("codeberg.org"), domain("gitea.com"), domain("try.gitea.io"), domain("gitdab.com"), domain("git.fsfe.org"), domain("git.passageenseine.fr"), domain("dev.sum7.eu") {
@import url("https://codeberg.org/Freeplay/CSS-Styles/raw/branch/main/Gitea/Gitea-modern-compiled.css");
@import url("https://codeberg.org/Freeplay/CSS-Styles/raw/branch/main/Gitea/theme-gitea-modern.css");
}