From 3c1ee9c154360815c83da87bb90d3fb5008bf3f5 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Sun, 18 Oct 2020 22:10:00 +0100 Subject: [PATCH] Updated Appearance (markdown) --- Appearance.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/Appearance.md b/Appearance.md index f45fc59..7a927c4 100644 --- a/Appearance.md +++ b/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. \ No newline at end of file +### 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! +