summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorDinesh <dineshudt17@gmail.com>2019-08-31 00:28:38 +0530
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2019-08-30 21:12:23 +0200
commit62d338fedbf909178823a299e79d14a947ac6335 (patch)
treec25b64dcdd9ce2dc0c01dad9e4e8a51fd580f9d4 /README.md
parent6190b663b6ed5d6ea45521265c82d8e1bf3885e9 (diff)
Add section for Sidebar description
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
index 16e22b2..5fa97e6 100644
--- a/README.md
+++ b/README.md
@@ -11,6 +11,7 @@ It pairs a prominent sidebar with uncomplicated content.
- [Installation](#installation)
- [Options](#options)
- [Sidebar menu](#sidebar-menu)
+ - [Sidebar description](#sidebar-description)
- [Sticky sidebar content](#sticky-sidebar-content)
- [Themes](#themes)
- [Reverse layout](#reverse-layout)
@@ -77,6 +78,25 @@ Menus:
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