mirror of
https://github.com/glanceapp/glance.git
synced 2025-06-22 10:51:24 +02:00
Update docs
This commit is contained in:
parent
7ffca9c3f1
commit
466d935d02
@ -179,27 +179,36 @@ You can adjust the various parts of the branding through a top level `branding`
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
branding:
|
branding:
|
||||||
show: true
|
custom-footer: |
|
||||||
name: Glance
|
<p>Powered by <a href="https://github.com/glanceapp/glance">Glance</a></p>
|
||||||
short-name: G
|
logo-url: /assets/logo.png
|
||||||
|
favicon-url: /assets/logo.png
|
||||||
```
|
```
|
||||||
|
|
||||||
### Properties
|
### Properties
|
||||||
|
|
||||||
| Name | Type | Required | Default |
|
| Name | Type | Required | Default |
|
||||||
| ---- | ---- | -------- | ------- |
|
| ---- | ---- | -------- | ------- |
|
||||||
| show | bool | no | true |
|
| hide-footer | bool | no | false |
|
||||||
| name | string | no | Glance |
|
| custom-footer | string | no | |
|
||||||
| short-name | string | no | G |
|
| logo-text | string | no | G |
|
||||||
|
| logo-url | string | no | |
|
||||||
|
| favicon-url | string | no | |
|
||||||
|
|
||||||
#### `show`
|
#### `hide-footer`
|
||||||
True will show the glance footer, false will hide it.
|
Hides the footer when set to `true`.
|
||||||
|
|
||||||
#### `name`
|
#### `custom-footer`
|
||||||
Sets the name presented after the page name in the title.
|
Specify custom HTML to use for the footer.
|
||||||
|
|
||||||
#### `short-name`
|
#### `logo-text`
|
||||||
Sets the name presented before the pages in the header.
|
Specify custom text to use instead of the "G" found in the navigation.
|
||||||
|
|
||||||
|
#### `logo-url`
|
||||||
|
Specify a URL to a custom image to use instead of the "G" found in the navigation. If both `logo-text` and `logo-url` are set, only `logo-url` will be used.
|
||||||
|
|
||||||
|
#### `favicon-url`
|
||||||
|
Specify a URL to a custom image to use for the favicon.
|
||||||
|
|
||||||
## Theme
|
## Theme
|
||||||
Theming is done through a top level `theme` property. Values for the colors are in [HSL](https://giggster.com/guide/basics/hue-saturation-lightness/) (hue, saturation, lightness) format. You can use a color picker [like this one](https://hslpicker.com/) to convert colors from other formats to HSL. The values are separated by a space and `%` is not required for any of the numbers.
|
Theming is done through a top level `theme` property. Values for the colors are in [HSL](https://giggster.com/guide/basics/hue-saturation-lightness/) (hue, saturation, lightness) format. You can use a color picker [like this one](https://hslpicker.com/) to convert colors from other formats to HSL. The values are separated by a space and `%` is not required for any of the numbers.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user