浏览代码

Document simple icons usage for monitor icons

Svilen Markov 1 年之前
父节点
当前提交
4206fb943d
共有 1 个文件被更改,包括 11 次插入1 次删除
  1. 11 1
      docs/configuration.md

+ 11 - 1
docs/configuration.md

@@ -898,7 +898,17 @@ The URL which will be requested and its response will determine the status of th
 
 
 `icon`
 `icon`
 
 
-Optional URL to an image which will be used as the icon for the site. Can be an external URL or internal via [server configured assets](#assets-path).
+Optional URL to an image which will be used as the icon for the site. Can be an external URL or internal via [server configured assets](#assets-path). You can also directly use [Simple Icons](https://simpleicons.org/) via a `si:` prefix:
+
+```yaml
+icon: si:jellyfin
+icon: si:gitea
+icon: si:adguard
+```
+
+> [!WARNING]
+>
+> Simple Icons are loaded externally and are hosted on `cdnjs.cloudflare.com`, if you do not wish to depend on a 3rd party you are free to download the icons individually and host them locally.
 
 
 `allow-insecure`
 `allow-insecure`