From 05894a731f29e7d473481ec850a2b154c32befdb Mon Sep 17 00:00:00 2001 From: Jieiku Date: Sun, 30 Jul 2023 22:51:57 -0700 Subject: Update Documentation --- COPY-TO-ROOT-SASS/abridge.scss | 2 +- README.md | 18 ++++++++++++++++++ config.toml | 2 +- 3 files changed, 20 insertions(+), 2 deletions(-) diff --git a/COPY-TO-ROOT-SASS/abridge.scss b/COPY-TO-ROOT-SASS/abridge.scss index 6ab3895..103d91e 100644 --- a/COPY-TO-ROOT-SASS/abridge.scss +++ b/COPY-TO-ROOT-SASS/abridge.scss @@ -10,7 +10,7 @@ $abridgeMode: "switcher",//valid values: switcher, auto, dark, light $syntax-mode: "auto",// Force syntax mode: auto, dark, light - $switcherDefault: "dark",// default for nojs switcher: dark, light + $switcherDefault: "dark",// default nojs switcher mode: dark, light (make sure to also set js_switcher_default in config.toml) $color: "orange",// color template to use/override: orange, blue, blueshade diff --git a/README.md b/README.md index 55dddc1..0db22ce 100644 --- a/README.md +++ b/README.md @@ -105,6 +105,24 @@ Saved changes will live reload in the browser. A lot of effort has been made to ensure Abridge features can be easily customized. +### Default Theme for nojs/noscript visitors. + +If you have abridge configured to use the switcher mode instead of auto/dark/light, then your site will have a button that allows the visitor to toggle the theme. + +If your visitor uses noscript or some other javascript blocking browser addon, then they will be stuck with whatever the configured default theme is for the switcher mode. + +To adjust this mode you would set the following two config values in abridge.scss **AND** config.toml: + +```scss +$switcherDefault: "dark",// default nojs switcher mode: dark, light (make sure to also set js_switcher_default in config.toml) +``` + +```toml +js_switcher_default = "dark" # default nojs switcher mode: dark, light (make sure to also set $switcherDefault in abridge.scss) +``` + +By default abrdige uses dark mode for the switcher, so unless you want to set the default mode to light for nojs visitors, then you do not need to worry about these settings. + ### Number of Items per page for pagination To change the number of items per page edit: `content/_index.md` and change the value for `paginate_by` diff --git a/config.toml b/config.toml index eebc404..495a088 100644 --- a/config.toml +++ b/config.toml @@ -205,7 +205,7 @@ integrity = true # increases site security, should normally be true. (setting to js_bundle = true # multiple javascript files combined into a single file (setting to false is useful during js development) js_switcher = true # The button that allows manually changing between light/dark mode. -js_switcher_default = "dark" # default switcher mode: dark, light +js_switcher_default = "dark" # default nojs switcher mode: dark, light (make sure to also set $switcherDefault in abridge.scss) js_copycode = true # The copy button on code blocks that allows you to copy them to the clipboard. -- cgit v1.3.1