aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJieiku2022-06-23 06:42:15 -0700
committerJieiku2022-06-23 06:42:15 -0700
commite7eb592764681e76d6c53c0059f79a54292d2538 (patch)
tree9a8e9e9c2e0e02bed6e4f24b1baa064e3a1463a5 /README.md
parentcf1085f8952f5c349c4fbfdfb619f6f09ac9afa6 (diff)
downloadabridge-e7eb592764681e76d6c53c0059f79a54292d2538.tar.gz
abridge-e7eb592764681e76d6c53c0059f79a54292d2538.tar.bz2
abridge-e7eb592764681e76d6c53c0059f79a54292d2538.zip
Update Abridge.woff2 and Readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index a51b73d..a178dc0 100644
--- a/README.md
+++ b/README.md
@@ -352,6 +352,21 @@ All pages extend to `base.html`, and you can customize them as need.
## Optional Performance Optimizations:
+### Abridge.woff2 Icon Font
+
+The Abridge.woff2 Icon Font is a subset of Font Awesome.
+
+This file can be overridden just like any other Zola theme file, by placing your own Abridge.woff2 in your sites root eg: `mysite/static/font/Abridge.woff2`
+
+To create your own Icon Font with other/more icons you can use the repository here: https://github.com/Jieiku/fontsubset
+
+You will also need to add the additional icon entries to `abridge/sass/fonts/_Abridge.scss`
+
+If you are running Abridge as a submodule, what you can do instead is copy `_Abridge.scss` as your own `mysite/sass/myfont.scss`, and then adjust your config.toml:
+
+instead of this: `stylesheets = [ "abridge-switcher.css" ]` do this: `stylesheets = [ "abridge-switcher.css", "myfont.css" ]`
+
+
### Theme-Switcher
The theme switcher relies on javascript to work, it applies the .light class to the root documentElement. The file that handles this (theme.js) is tiny and optimized and it is the first file loaded in the head, so the performance hit is minimal, but it does still exist. Without the Theme switcher you can still use The automatic Theme, it works by using Browser/OS preference, you can even install a [Firefox plugin](https://addons.mozilla.org/en-US/firefox/addon/theme-switcher-for-firefox/) to quickly switch between the two. By default the demo has the theme switcher enabled so that it can be evaluated.