π A self-hostable personal dashboard built for you. Includes status-checking, widgets, themes, icon packs, a UI editor and tons more!
Vue awesomedashboarddockerhomelabhomepagemitnodejsorganizationproductivitypwaself-hostedstartpagevue
:memo: Adds docs for pageInfo.logo attribute
Alicia Sykes644739028f3a
diff --git a/README.md b/README.mdindex 5e495cb9..bcf041bf 100644--- a/README.md+++ b/README.md@@ -345,6 +345,8 @@ Custom links for the navigation menu are defined under [`pageInfo.navLinks`](httYou can display either custom text or HTML in the footer, using the `pageInfo.footerText` attribute.+To display a logo or image asset next to the title, set `pageInfo.logo` to the path to your picture (either local or remote).+It's also possible to hide parts of the page that you do not need (e.g. navbar, footer, search, heading, etc). This is done using the [`appConfig.hideComponents`](https://github.com/Lissy93/dashy/blob/master/docs/configuring.md#appconfighidecomponents-optional) attribute.For example, a `pageInfo` section might look something like this:diff --git a/docs/configuring.md b/docs/configuring.mdindex 4e1ca038..3b03513c 100644--- a/docs/configuring.md+++ b/docs/configuring.md@@ -38,6 +38,7 @@ To disallow any changes from being written to disk via the UI config editor, set**`description`** | `string` | _Optional_ | Description of your dashboard, also displayed as a subtitle**`navLinks`** | `array` | _Optional_ | Optional list of a maximum of 6 links, which will be displayed in the navigation bar. See [`navLinks`](#pageinfonavlinks-optional)**`footerText`** | `string` | _Optional_ | Text to display in the footer (note that this will override the default footer content). This can also include HTML and inline CSS+**`logo`** | `string` | _Optional_ | The path to an image to display in the header (to the right of the title). This can be either local, where `/` is the root of `./public`, or any remote image, such as `https://i.ibb.co/yhbt6CY/dashy.png`. It's recommended to scale your image down, so that it doesn't impact load times**[β¬οΈ Back to Top](#configuring)**