mirror of
https://github.com/DI0IK/homepage-plus.git
synced 2025-07-17 02:09:49 +00:00
add mkdocs
This commit is contained in:
parent
b215843b26
commit
47765ee05e
144 changed files with 4219 additions and 3 deletions
35
docs/widgets/index.md
Normal file
35
docs/widgets/index.md
Normal file
|
@ -0,0 +1,35 @@
|
|||
---
|
||||
title: Widgets
|
||||
description: Homepage info and status widgets.
|
||||
---
|
||||
|
||||
Homepage has two types of widgets: info and service. Below we'll cover each type and how to configure them.
|
||||
|
||||
## Service Widgets
|
||||
|
||||
Service widgets are used to display the status of a service, often a web service or API. Services (and their widgets) are defined in your `services.yml` file. Here's an example:
|
||||
|
||||
```yaml
|
||||
- Plex:
|
||||
icon: plex.png
|
||||
href: https://plex.my.host
|
||||
description: Watch movies and TV shows.
|
||||
server: localhost
|
||||
container: plex
|
||||
widget:
|
||||
type: tautulli
|
||||
url: http://172.16.1.1:8181
|
||||
key: aabbccddeeffgghhiijjkkllmmnnoo
|
||||
```
|
||||
|
||||
## Info Widgets
|
||||
|
||||
Info widgets are used to display information in the header, often about your system or environment. Info widgets are defined your `widgets.yml` file. Here's an example:
|
||||
|
||||
```yaml
|
||||
- openmeteo:
|
||||
label: Current
|
||||
latitude: 36.66
|
||||
longitude: -117.51
|
||||
cache: 5
|
||||
```
|
Loading…
Add table
Add a link
Reference in a new issue