Add repository overview and theme installation instructions

This commit is contained in:
clay 2026-11-09 14:29:02 -05:00
parent f9979b4550
commit 9d30f14bce

View file

@ -0,0 +1,59 @@
# Fluxer Themes
A collection of custom CSS themes for Fluxer, organised by creator.
Browse the themes below, check out their previews, and follow the installation instructions to try one yourself.
## Available themes
| Theme | Creator | Description |
| --- | --- | --- |
| [Factorio](clarth/factorio/) | Clarth | A Factorio-inspired theme for Fluxer. |
Each theme lives in its own folder with a `theme.css` file and a README containing theme-specific details and screenshots.
## Creators
- [Clarth](clarth/)
- [Ashmata](ashmata/)
## Getting started
Download a theme’s `theme.css` file to import it into Fluxer, or copy its contents into Quick CSS to try it out. See the installation instructions below for the full steps.
## Installing a theme
### Import a theme into your library
Use this method to keep a theme installed and easily turn it on or off.
1. Browse this repository and open the folder for the theme you want.
2. Download its `theme.css` file. On Forgejo, open the file and use the download button to save the CSS file—not the webpage.
3. In Fluxer, open Settings → Themes → Your Themes.
4. Click Import CSS and select the downloaded `theme.css` file.
5. Once imported, use the checkbox beside the theme to enable or disable it.
### Try a theme with Quick CSS
Quick CSS lets you test a theme before importing it or experiment with changes while viewing the results.
1. Open the theme’s `theme.css` file in this repository and copy its entire contents.
2. In Fluxer, open Settings → Themes → Quick CSS.
3. Click Open Quick CSS Editor.
4. Back up any CSS already in the editor before replacing it.
5. Paste the theme’s CSS into the editor.
6. With live preview enabled, changes appear as you edit. If live preview is disabled, click Apply changes.
When you are happy with the theme, import its `theme.css` file using the library method above so you can enable or disable it from Your Themes.
Avoid leaving the same theme active in both Quick CSS and Your Themes. After importing it, remove the test copy from Quick CSS, preserving any unrelated custom CSS.
### Editing a theme
Use the Quick CSS editor to experiment with colours, spacing, fonts, and other styles. Changes made there do not update this repository’s `theme.css` file—copy any changes you want to keep back into the file.
### Troubleshooting
- If the theme does not appear, check that its checkbox is enabled under Your Themes.
- If the appearance looks wrong, try disabling other themes and temporarily removing unrelated Quick CSS to check for conflicting styles.
- If custom CSS makes Fluxer difficult to use, press `Ctrl+Alt+Shift+K` to temporarily turn custom CSS off. Fix or disable the offending CSS before turning it back on.