Update README.md

This commit is contained in:
Magnus Åhall 2023-07-25 14:03:36 +00:00
parent 41292bdbac
commit a354be00bd

View File

@ -55,3 +55,50 @@ gruvbox: # Name of theme.
hover: brighter # Determines mouse pointer hovering over section background color. hover: brighter # Determines mouse pointer hovering over section background color.
#Can be brighter, darker or anything else to disable behaviour. #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 <web root>/foo.yaml
label: Foo
page:
theme: default # name of theme when loading the page, corresponding to the same name in <web root>/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
```