hrfee/jfa-go
1
0
Fork 0
mirror of https://github.com/hrfee/jfa-go.git synced 2024-11-22 02:10:10 +00:00
Code Issues Projects Releases Wiki Activity

Updated Appearance (markdown)

Harvey Tindall 2021-01-11 20:25:20 +00:00
parent 60260f5c65
commit 08ec138a82
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Appearance.md

@ -1,15 +1,15 @@
### CSS
jfa-go uses Bootstrap, which is relatively easy to customize. There are 3 options in the "Look" or `themes` section of the config, "Bootstrap", "Jellyfin" and "Custom CSS".
* `Bootstrap` is the default appearance of Bootstrap, and is a light theme.
jfa-go uses [a17t](https://a17t.miles.land), which is relatively easy to customize. There are 2 options in the "Look" or `themes` section of the config, "Default", "Jellyfin".
* `Default` is the default appearance of Bootstrap, and is a light theme.
* `Jellyfin` is a passing attempt to recreate the Jellyfin look , and is a dark theme.
* `Custom CSS` allows you to include your own custom style. Once this is set, set `files/custom_css` to the path to the .css file. (For docker users, make sure the file is accessible within the container.) [This](https://github.com/hrfee/jellyfin-accounts/tree/master/scss) guide to compiling scss may be helpful. Make sure the CSS file corresponds to the version of bootstrap (4 or 5).
Custom CSS can be achieved by modifying `css/base.css` in the source code, or `<folder with jfa-go>/build/data/web/css/base.css` in a compiled version. This will replace the default theme, modify the `dark.css` file next to it if you want to replace the Jellyfin theme. See [this](https://a17t.miles.land/customize/) for info on customizing a17t's CSS variables.
### HTML
support for custom HTML is a bit rudimentary. One can specify a path to a folder containing customized HTML files with the `files/html_templates` setting. Any files that match the names of jfa-go's internal templates will be loaded instead. The files use go's built in templating language, so familiarize yourself with it first ([a good resource](https://blog.gopheracademy.com/advent-2017/using-go-templates/)) so you know what different parts do. You can find the internal templates [here](https://github.com/hrfee/jfa-go/tree/main/data/templates).
One can specify a path to a folder containing customized HTML files with the `files/html_templates` setting. Any files that match the names of jfa-go's internal templates will be loaded instead. The files use go's built in templating language, so familiarize yourself with it first ([a good resource](https://blog.gopheracademy.com/advent-2017/using-go-templates/)) so you know what different parts do. You can find the internal templates [here](https://github.com/hrfee/jfa-go/tree/main/data/templates).
Additionally, All text on the page, including password requirement strings (e.g "Must have at least n characters") can be customized. Copy one of the internal language files in the `data/lang/form` directory, and change at least the `"meta": { name: "" }` field (This is the name that will appear in settings). You can then modify the `"validationStrings"` values. Restart jfa-go and you should see a new option in Settings > General > Language.
Additionally, All text on the page, including password requirement strings (e.g "Must have at least n characters") can be customized. Copy one of the internal language files in the `lang/form` or `<folder with jfa-go>/build/data/lang/form` directory, and change at least the `"meta": { name: "" }` field (This is the name that will appear in settings). You can also edit an existing file to overwrite it. Restart jfa-go and you should see a new option in Settings > General > Language.
Good luck!