diff --git a/docs/configuring.md b/docs/configuring.md index fac29c9d..880d0a41 100644 --- a/docs/configuring.md +++ b/docs/configuring.md @@ -322,7 +322,7 @@ For more info, see the **[Authentication Docs](/docs/authentication)** **Field** | **Type** | **Required**| **Description** --- | --- | --- | --- -**`icon`** | `string` | _Optional_ | The icon for a given item or section.
See [Icon Docs](/docs/icons) for all available supported icon types, including: auto-fetched favicons, generative icons, emoji icons, home-lab service logos, font-awesome, simple-icons, material icons, and icons specified by URL +**`icon`** | `string` | _Optional_ | The icon for a given item or section.
See [Icon Docs](/docs/icons) for all available supported icon types, including: auto-fetched favicons, generative icons, emoji icons, home-lab service logos, font-awesome, simple-icons, material icons, selfh.st icons, and icons specified by URL **[⬆️ Back to Top](#top)** diff --git a/docs/icons.md b/docs/icons.md index df0e9c69..67ef94fd 100644 --- a/docs/icons.md +++ b/docs/icons.md @@ -7,6 +7,7 @@ Both sections and items can have an icon, which is specified using the `icon` at - [Simple Icons](#simple-icons) - [Generative Icons](#generative-icons) - [Emoji Icons](#emoji-icons) +- [selfh.st Icons](#selfhst-icons) - [Home-Lab Icons](#home-lab-icons) - [Material Icons](#material-design-icons) - [Icons by URL](#icons-by-url) @@ -109,6 +110,18 @@ For example, these will all render the same rocket (🚀) emoji: `icon: ':rocket --- +## selfh.st Icons + +The [selfh.st](https://selfh.st/) project provides a set of icons, originally for self-hosted services, but now expanded to include a wide variety of services. These icons can be used by specifying the icon name (without extension and with all spaces replaced with -) preceded by `sh-`. See https://selfh.st/icons/ for a full list of all available icons. For example, the Home Assistant icon is `sh-home-assistant`. + +Note: These icons are fetched from the jsdelivr CDN, so if you require offline access, the [Local Icons](#local-icons) method may be a better option for you. + +

+ +

+ +--- + ## Home-Lab Icons The [dashboard-icons](https://github.com/walkxcode/Dashboard-Icons) repo by [@WalkxCode](https://github.com/WalkxCode) provides a comprehensive collection of 360+ high-quality PNG icons for commonly self-hosted services. Dashy natively supports these icons, and you can use them just by specifying the icon name (without extension) preceded by `hl-`. See [here](https://github.com/walkxcode/Dashboard-Icons/tree/main/png) for a full list of all available icons. Note that these are fetched and cached straight from GitHub, so if you require offline access, the [Local Icons](#local-icons) method may be a better option for you.