mirror of
https://github.com/Lissy93/dashy.git
synced 2025-07-28 16:14:33 +02:00
Auto Publish new pages
liss-bot
parent
9b706888f4
commit
f051e00d0a
965
credits.md
965
credits.md
File diff suppressed because it is too large
Load Diff
@ -504,9 +504,11 @@ Usually, Font Awesome will be automatically enabled if one or more of your icons
|
||||
|
||||
If you are trying to use a premium icon, then you must have a [Pro License](https://fontawesome.com/plans). You'll then need to specify your Pro plan API key under `appConfig.fontAwesomeKey`. You can find this key, by logging into your FA account, navigate to Account → [Kits](https://fontawesome.com/kits) → New Kit → Copy Kit Code. The code is a 10-digit alpha-numeric code, and is also visible within the new kit's URL, for example: `81e48ce079`.
|
||||
|
||||
<p align="center"><img src="https://i.ibb.co/hZ0D9vs/where-do-i-find-my-font-awesome-key.png" width="600" /></p>
|
||||
|
||||
Be sure that you're specifying the icon category and name correctly. You're icon should look be `[category] fa-[icon-name]`. The following categories are supported: `far` _(regular)_, `fas` _(solid)_, `fal`_(light)_, `fad` _(duo-tone)_ and `fab`_(brands)_. With the exception of brands, you'll usually want all your icons to be in from same category, so they look uniform.
|
||||
|
||||
Ensure the icon you are trying to use, is available within [FontAwesome Version 5](https://fontawesome.com/v5/search).
|
||||
Ensure the icon you are trying to use, is available within [FontAwesome Version 5](https://fontawesome.com/v5/search) (we've not yet upgraded to V6, as it works a little differently).
|
||||
|
||||
Examples: `fab fa-raspberry-pi`, `fas fa-database`, `fas fa-server`, `fas fa-ethernet`
|
||||
|
||||
|
||||
38
widgets.md
38
widgets.md
@ -151,6 +151,8 @@ A simple, live-updating local weather component, showing temperature, conditions
|
||||
**`city`** | `string` | Required | A city name to use for fetching weather. This can also be a state code or country code, following the ISO-3166 format
|
||||
**`units`** | `string` | _Optional_ | The units to use for displaying data, can be either `metric` or `imperial`. Defaults to `metric`
|
||||
**`hideDetails`** | `boolean` | _Optional_ | If set to `true`, the additional details (wind, humidity, pressure, etc) will not be shown. Defaults to `false`
|
||||
**`lat`** | `number` | _Optional_ | To show weather for a specific location, you can provide the latitude and longitude coordinates. If provided, this will override the `city` option
|
||||
**`lon`** | `number` | _Optional_ | To show weather for a specific location, you can provide the latitude and longitude coordinates. If provided, this will override the `city` option
|
||||
|
||||
#### Example
|
||||
|
||||
@ -160,7 +162,7 @@ A simple, live-updating local weather component, showing temperature, conditions
|
||||
apiKey: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
|
||||
city: London
|
||||
units: metric
|
||||
hideDetails: false
|
||||
hideDetails: true
|
||||
```
|
||||
|
||||
#### Info
|
||||
@ -2331,6 +2333,22 @@ Live-updating current CPU usage, as a combined average across all cores
|
||||
|
||||
---
|
||||
|
||||
### Current CPU Usage Speedometer
|
||||
|
||||
Speedometer styled version of the Current CPU Usage widget
|
||||
|
||||
<p align="center"><img width="400" src="https://i.ibb.co/7RHTRNq/gl-cpu-speedometer.png" /></p>
|
||||
|
||||
#### Example
|
||||
|
||||
```yaml
|
||||
- type: gl-cpu-speedometer
|
||||
options:
|
||||
hostname: http://192.168.130.2:61208
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### CPU Usage Per Core
|
||||
|
||||
Live-updating CPU usage breakdown per core
|
||||
@ -2386,6 +2404,22 @@ Real-time memory usage gauge, with more info visible on click
|
||||
|
||||
---
|
||||
|
||||
### Current Memory Usage Speedometer
|
||||
|
||||
Speedometer styled version of the Current Memory Usage widget
|
||||
|
||||
<p align="center"><img width="400" src="https://i.ibb.co/wsNW7Xr/gl-mem-speedometer.png" /></p>
|
||||
|
||||
#### Example
|
||||
|
||||
```yaml
|
||||
- type: gl-mem-speedometer
|
||||
options:
|
||||
hostname: http://192.168.130.2:61208
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### Memory Usage History
|
||||
|
||||
Recent memory usage chart
|
||||
@ -2878,7 +2912,7 @@ Please only request widgets for services that:
|
||||
|
||||
You can suggest a widget [here](https://git.io/Jygo3), please star the repo before submitting a ticket. If you are a monthly GitHub sponsor, I will happily build out a custom widget for any service that meets the above criteria, usually within 2 weeks of initial request.
|
||||
|
||||
For services that are not officially supported, it is likely still possible to display data using either the [iframe](#iframe-widget), [embed](#html-embedded-widget) or [API response](#api-response) widgets. For more advanced features, like charts and action buttons, you could also build your own widget, using [this tutorial](/docs/development-guides.md#building-a-widget), it's fairly straight forward, and you can use an [existing widget](https://github.com/Lissy93/dashy/tree/master/src/components/Widgets) (or [this example](https://git.io/JygKI)) as a template.
|
||||
For services that are not officially supported, it is likely still possible to display data using either the [iframe](#iframe-widget), [embed](#html-embedded-widget) or [API response](#api-response) widgets. For more advanced features, like charts and action buttons, you could also build your own widget, using [this tutorial](/docs/development-guides.md/#building-a-widget), it's fairly straight forward, and you can use an [existing widget](https://github.com/Lissy93/dashy/tree/master/src/components/Widgets) (or [this example](https://git.io/JygKI)) as a template.
|
||||
|
||||
---
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user