Add section for Sidebar description
This commit is contained in:
parent
6190b663b6
commit
62d338fedb
20
README.md
20
README.md
|
@ -11,6 +11,7 @@ It pairs a prominent sidebar with uncomplicated content.
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [Options](#options)
|
- [Options](#options)
|
||||||
- [Sidebar menu](#sidebar-menu)
|
- [Sidebar menu](#sidebar-menu)
|
||||||
|
- [Sidebar description](#sidebar-description)
|
||||||
- [Sticky sidebar content](#sticky-sidebar-content)
|
- [Sticky sidebar content](#sticky-sidebar-content)
|
||||||
- [Themes](#themes)
|
- [Themes](#themes)
|
||||||
- [Reverse layout](#reverse-layout)
|
- [Reverse layout](#reverse-layout)
|
||||||
|
@ -77,6 +78,25 @@ Menus:
|
||||||
URL: "https://www.linkedin.com/in/username/"
|
URL: "https://www.linkedin.com/in/username/"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
### Sidebar description
|
||||||
|
Customise the describe of your page using `description`, like so:
|
||||||
|
|
||||||
|
**TOML**
|
||||||
|
```toml
|
||||||
|
theme = "hyde"
|
||||||
|
|
||||||
|
[params]
|
||||||
|
description = "Your custom description"
|
||||||
|
```
|
||||||
|
|
||||||
|
**YAML**
|
||||||
|
```yaml
|
||||||
|
theme: "hyde"
|
||||||
|
|
||||||
|
params:
|
||||||
|
description = "Your custom description"
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
### Sticky sidebar content
|
### Sticky sidebar content
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue