From 997937af5a6dc317da56ae294dce927ec5930a4b Mon Sep 17 00:00:00 2001
From: Geoffrey Garrett <g.h.garrett13@gmail.com>
Date: Mon, 27 Jun 2022 22:45:48 +0000
Subject: [PATCH] docs(config.md): Added short explainer on favicons
---
content/notes/config.md | 40 ++++++++++++++++++++++++++++++++++++++++
1 files changed, 40 insertions(+), 0 deletions(-)
diff --git a/content/notes/config.md b/content/notes/config.md
index d04b152..8c758ed 100644
--- a/content/notes/config.md
+++ b/content/notes/config.md
@@ -23,6 +23,46 @@
link: https://github.com/jackyzha0
```
+### HTML Favicons
+
+A Favicon is most commonly seen preceding the URL in a browser. Some
+other examples include (but are not limited to) bookmarks, search history, and
+app icons (i.e. "save page to homescreen" on mobile devices). [File format support](https://en.wikipedia.org/wiki/Favicon#File_format_support)
+and the [use of favicons](https://en.wikipedia.org/wiki/Favicon#Use_of_favicon) differ
+across the combination of platforms and browsers.
+
+If you would like to customize the favicons of your website, you can add them to the `data/config.yaml` file. The **default** without any set `favicon` key is:
+
+```html
+<link rel="shortcut icon" href="icon.png" type="image/png">
+```
+
+The default can be overridden by defining a value to the `favicon` key in your `data/config.yaml` file. Here is a `List[Dictionary]` example format, which is equivalent to the default:
+
+```yaml
+favicon:
+ - { rel: "shortcut icon", href: "icon.png", type: "image/png" }
+```
+
+In this format, the following keys are available:
+- `rel`: The `rel` attribute of the `<link>` tag.
+- `type`: The `type` attribute of the `<link>` tag.
+- `href` (optional): The `href` attribute of the `<link>` tag.
+- `sizes` (optional): The `sizes` attribute of the `<link>` tag.
+
+If you plan to add multiple favicons generated by a website, it may be easier to define it as HTML:
+
+```yaml
+favicon: |
+ <link rel="shortcut icon" href="icon.png" type="image/png">
+```
+
+Some websites that **generate favicons** for you (ordered alphabetically) include:
+- [`favicon.io`](https://favicon.io/)
+- [`realfavicongenerator.net`](https://realfavicongenerator.net/)
+- [`www.favicon.cc`](https://www.favicon.cc/)
+
+
### Graph View
To customize the Interactive Graph view, you can poke around `data/graphConfig.yaml`.
--
Gitblit v1.10.0