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 2020-10-18 22:10:00 +01:00
parent d59698d2c6
commit 3c1ee9c154
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Appearance.md

@ -1,6 +1,11 @@
### 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.
* `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).
You may also want to completely change the design. This is not properly facilitated for the web pages, but can be done by modifying `admin.html`, `form.html`, etc. in the `data/templates` directory, and placing any static files (such as javascript) in the `data/static` directory wherever jfa-go has been installed. For emails, the `email_html` and `email_text` options specify the path to custom email files.
### 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). Good luck!