From a354be00bdd28a1df5813582739ccc012f51f249 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Magnus=20=C3=85hall?= Date: Tue, 25 Jul 2023 14:03:36 +0000 Subject: [PATCH] Update README.md --- README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) diff --git a/README.md b/README.md index 4834917..dc6684b 100644 --- a/README.md +++ b/README.md @@ -54,4 +54,51 @@ gruvbox: # Name of theme. icon: # Icon can be left blank, same behaviour as label. hover: brighter # Determines mouse pointer hovering over section background color. #Can be brighter, darker or anything else to disable behaviour. +``` + +# Dashboard YAML files + +Icons use the Material Design Icons library, see https://pictogrammers.com/library/mdi/ for a searchable list of icons. To use the abacus icon, type "abacus" in the icon property of the section items. + +Version added here was v7.2.96. + +```yaml +# Pages to be displayed in the header. +# Pages doesn't have be defined here, the file can still be accessed +# by visiting /?page=filename (without .yaml). +# This could be used to create elaborate site hierarchies. + +pages: + - name: start # this has to correspond to the filename.yaml in the web root. + label: Home + + - name: foo # this would be /foo.yaml + label: Foo + +page: + theme: default # name of theme when loading the page, corresponding to the same name in /themes.yaml. + label: Home # doesn't have to be the same as the name or label in the pages array. + +sections: + - label: Search + items: + - label: Google + url: https://www.google.com + icon: google + + - label: DuckDuckGo + description: '"Privacy, simplified."' # The description field is optional. + url: https://duckduckgo.com + icon: duck + + - label: Multimedia + items: + - label: Jellyfin + description: The free software media system + url: https://jellyfin.org + icon: filmstrip + + - label: Spotify + url: https://spotify.com + icon: music ``` \ No newline at end of file