diff --git a/docs/configs/favicons.md b/docs/configs/favicons.md new file mode 100644 index 00000000..d89cc89b --- /dev/null +++ b/docs/configs/favicons.md @@ -0,0 +1,55 @@ +--- +title: Favicons +description: Favicon Configuration +--- + +Favicons are configured in the `favicons.yaml` file. They function much the same as [Bookmarks](bookmarks.md), in how groups and lists work. They're just simple icons with no extra features other than being a link out. + +The design of homepage expects `abbr` to be 2 letters, but is not otherwise forced. The `abbr` shows if the icon is not specified. + +You should use an icon for favicons similar to the [options for service icons](services.md#icons). If both icon and abbreviation are supplied, the icon takes precedence. + + +```yaml +--- +- Developer: + - Github: + - abbr: GH + name: Github + icon: github.png + href: https://github.com/ + - Gitlab: + - abbr: GL + name: Gitlab + icon: gitlab.png + href: https://gitlab.com + +- Media: + - Jellyfin: + - abbr: JE + name: jellyfin + icon: jellyfin.png + href: https://jellyfin.org + - Emby: + - abbr: EM + name: emby + icon: emby.png + href: https://emby.media + - Youtube: + - abbr: YT + name: youtube + icon: youtube.png + href: https://youtube.com/ + - Spotify: + - abbr: SP + name: spotify + icon: spotify.png + href: https://spotify.com/ + +``` + +which renders to (depending on your theme): + +Favicons + +The default [favicons.yaml](https://github.com/gethomepage/homepage/blob/main/src/skeleton/favicons.yaml) is a working example. diff --git a/src/skeleton/favicons.yaml b/src/skeleton/favicons.yaml new file mode 100644 index 00000000..58f76360 --- /dev/null +++ b/src/skeleton/favicons.yaml @@ -0,0 +1,47 @@ +--- +# For configuration options and examples, please see: +# https://gethomepage.dev/configs/favicons +- Developer: + - Github: + - abbr: GH + name: Github + icon: github.png + href: https://github.com + - Gitlab: + - abbr: GL + name: Gitlab + icon: gitlab.png + href: https://gitlab.com + +- Media: + - Jellyfin: + - abbr: JE + name: jellyfin + icon: jellyfin.png + href: https://jellyfin.org + - Emby: + - abbr: EM + name: emby + icon: emby.png + href: https://emby.media + - Youtube: + - abbr: YT + name: youtube + icon: youtube.png + href: https://youtube.com + - Spotify: + - abbr: SP + name: spotify + icon: spotify.png + href: https://spotify.com +- Social: + - Facebook: + - abbr: FB + name: facebook + icon: facebook.png + href: https://facebook.com + - Reddit: + - abbr: RE + name: reddit + icon: reddit.png + href: https://reddit.com \ No newline at end of file