Updated Appearance (markdown)

Harvey Tindall 2020-07-05 16:49:09 +01:00
parent caa4e1984e
commit 72acb07a51

@ -1,5 +1,6 @@
jellyfin-accounts uses Bootstrap and inherits its appearance, but you can customize this to some extent. The `custom_css` option under the Files section in your settings allows you to specify the path to a customized version of bootstrap, enabling you to change how your instance looks. [Bootswatch](https://bootswatch.com) is a great resource for finding custom CSS. If you wish to switch things up even more, you can customize Bootstrap through sass. The 'bs5' branch uses Bootstrap 5 and includes a new Jellyfin-style color scheme, from which you may want to draw inspiration. The `scss` directory there has some details on doing this, although `bs5-jf.scss` will not be fully compatible with normal jellyfin-accounts packages. jellyfin-accounts 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.
Once you have something, make sure the file you specify is accessible to jf-accounts, so for docker, place it next to your configuration file and set `custom_css` to `/config/<your file.css>`. 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/static` directory wherever jellyfin-accounts has been installed. For me, this is `~/.local/lib/python3.8/site-packages/jellyfin_accounts-0.1-py3.8.egg/`. For emails, the `email_html` and `email_text` options specify the path to custom email files.
You may also want to completely change the look. This is not properly facilitated for the web pages, but can be done by modifying `admin.html`, `form.html`, etc. in the `data/static` directory wherever jellyfin-accounts has been installed. For me, this is `~/.local/lib/python3.8/site-packages/jellyfin_accounts-0.1-py3.8.egg/`. For emails, the `email_html` and `email_text` options specify the path to custom email files.