docs(content/notes/config.md): Adds documentation for the new favicon support
This commit is contained in:
		
							parent
							
								
									473ea2c66f
								
							
						
					
					
						commit
						a334b45b17
					
				
					 1 changed files with 34 additions and 0 deletions
				
			
		| 
						 | 
					@ -23,6 +23,40 @@ links: # Links to show in footer
 | 
				
			||||||
    link: https://github.com/jackyzha0
 | 
					    link: https://github.com/jackyzha0
 | 
				
			||||||
```
 | 
					```
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					### HTML Favicons
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					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
 | 
					### Graph View
 | 
				
			||||||
To customize the Interactive Graph view, you can poke around `data/graphConfig.yaml`.
 | 
					To customize the Interactive Graph view, you can poke around `data/graphConfig.yaml`.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue