mirror of https://github.com/Lissy93/dashy.git
📝 Adds widget docs to readme
This commit is contained in:
parent
7cd6e64b30
commit
e628650dd1
17
README.md
17
README.md
|
@ -40,6 +40,7 @@
|
|||
- [🎨 Theming](#theming-)
|
||||
- [🧸 Icons](#icons-)
|
||||
- [🚦 Status Indicators](#status-indicators-)
|
||||
- [📊 Widgets](#widgets-)
|
||||
- [💂 Authentication](#authentication-)
|
||||
- [🖱️ Opening Methods](#opening-methods-%EF%B8%8F)
|
||||
- [👓 Alternate Views](#alternate-views-)
|
||||
|
@ -235,6 +236,22 @@ Status indicators can be globally enabled by setting `appConfig.statusCheck: tru
|
|||
<img alt="Status Checks demo" src="https://raw.githubusercontent.com/Lissy93/dashy/master/docs/assets/status-check-demo.gif" width="600" />
|
||||
</p>
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
---
|
||||
|
||||
## Widgets 📊
|
||||
|
||||
> For full widget documentation, see: [**Widgets**](./docs/widgets.md)
|
||||
|
||||
You can display dynamic content from services in the form of widgets. There are several pre-built widgets availible for showing useful info, and integrations with commonly self-hosted services, but you can also easily create your own for almost any app.
|
||||
|
||||
|
||||
<p align="center">
|
||||
<img width="600" src="https://i.ibb.co/GFjXVHy/dashy-widgets.png" />
|
||||
</p>
|
||||
|
||||
|
||||
**[⬆️ Back to Top](#dashy)**
|
||||
|
||||
---
|
||||
|
|
|
@ -43,6 +43,7 @@ Dashy has support for displaying dynamic content in the form of widgets. There a
|
|||
- [Widget Usage Guide](#widget-usage-guide)
|
||||
- [Continuous Updates](#continuous-updates)
|
||||
- [Custom CSS Styling](#widget-styling)
|
||||
- [Language Translations](#language-translations)
|
||||
- [Widget UI Options](#widget-ui-options)
|
||||
- [Building a Widget](#build-your-own-widget)
|
||||
|
||||
|
@ -1158,6 +1159,16 @@ For more info on how to apply custom variables, see the [Theming Docs](/docs/the
|
|||
|
||||
---
|
||||
|
||||
### Language Translations
|
||||
|
||||
Since most of the content displayed within widgets is fetched from an external API, unless that API supports multiple languages, translating dynamic content is not possible.
|
||||
|
||||
However, any hard-coded content is translatable, and all dates and times will display in your local format.
|
||||
|
||||
For more info about multi-language support, see the [Internationalization Docs](/docs/multi-language-support.md).
|
||||
|
||||
---
|
||||
|
||||
### Widget UI Options
|
||||
|
||||
Widgets can be opened in full-page view, by clicking the Arrow icon (top-right). The URL in your address bar will also update, and visiting that web address will take you straight to the selected widget.
|
||||
|
|
Loading…
Reference in New Issue