Browse Source

Add section for Sidebar description

Dinesh 4 years ago
parent
commit
62d338fedb
1 changed files with 20 additions and 0 deletions
  1. 20
    0
      README.md

+ 20
- 0
README.md View File

@@ -11,6 +11,7 @@ It pairs a prominent sidebar with uncomplicated content.
11 11
 - [Installation](#installation)
12 12
 - [Options](#options)
13 13
   - [Sidebar menu](#sidebar-menu)
14
+  - [Sidebar description](#sidebar-description)
14 15
   - [Sticky sidebar content](#sticky-sidebar-content)
15 16
   - [Themes](#themes)
16 17
   - [Reverse layout](#reverse-layout)
@@ -77,6 +78,25 @@ Menus:
77 78
       URL: "https://www.linkedin.com/in/username/"
78 79
 ```
79 80
 
81
+### Sidebar description
82
+Customise the describe of your page using `description`, like so:
83
+
84
+**TOML**
85
+```toml
86
+theme = "hyde"
87
+
88
+[params]
89
+  description = "Your custom description"
90
+```
91
+
92
+**YAML**
93
+```yaml
94
+theme: "hyde"
95
+
96
+params:
97
+  description = "Your custom description"
98
+```
99
+
80 100
 
81 101
 ### Sticky sidebar content
82 102