From 62d338fedbf909178823a299e79d14a947ac6335 Mon Sep 17 00:00:00 2001 From: Dinesh Date: Sat, 31 Aug 2019 00:28:38 +0530 Subject: Add section for Sidebar description --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) 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 -- cgit v1.2.1-24-ge1ad