Skip to content

Commit

Permalink
Add light & dark theme SVG favicon option docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tlindsay42 authored and McShelby committed Jun 5, 2023
1 parent ad0378a commit 4548d01
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions exampleSite/content/basics/customization/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,13 @@ The size of the logo will adapt automatically

If your favicon is a SVG, PNG or ICO, just drop off your image in your local `static/images/` folder and name it `favicon.svg`, `favicon.png` or `favicon.ico` respectively.

Alternatively, if you want your site to use light & dark theme SVG favicons that follow the OS' (and in some cases, the browser's) color scheme, add the image files to your local `static/images/` folder and name them `favicon-light.svg` and `favicon-dark.svg` respectively.

{{% notice warning %}}
IE and old browser versions do not support [media queries](https://caniuse.com/css-media-interaction), which are necessary for the light & dark theme favicon option.
If you have requirements to support IE and/or older browser versions, use one of the other options.
{{% /notice %}}

If no favicon file is found, the theme will lookup the alternative filename `logo` in the same location and will repeat the search for the list of supported file types.

If you need to change this default behavior, create a new file in `layouts/partials/` named `favicon.html`. Then write something like this:
Expand Down

0 comments on commit 4548d01

Please sign in to comment.