summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDinesh <dineshudt17@gmail.com>2019-08-31 00:27:59 +0530
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2019-08-30 21:12:23 +0200
commit6190b663b6ed5d6ea45521265c82d8e1bf3885e9 (patch)
tree36e14cc0cc11f91c02f79b713235563803597bc5
parent8bfa46de4850c1bf018adf396e413474a19ba96d (diff)
Add example for Sidebar menus
-rw-r--r--README.md25
1 files changed, 24 insertions, 1 deletions
diff --git a/README.md b/README.md
index 04d9654..16e22b2 100644
--- a/README.md
+++ b/README.md
@@ -52,7 +52,30 @@ Hyde includes some customizable options, typically applied via classes on the `<
### Sidebar menu
-Create a list of nav links in the sidebar by assigning "menu=main" in the front matter.
+Create a list of nav links in the sidebar by assigning "menu=main" in the front matter, like so:
+
+**TOML**
+```toml
+theme = "hyde"
+
+[Menus]
+ main = [
+ {Name = "Github", URL = "https://github.com/username/"},
+ {Name = "LinkedIn", URL = "https://www.linkedin.com/in/username/"}
+ ]
+```
+
+**YAML**
+```yaml
+theme: "hyde"
+
+Menus:
+ main:
+ - Name: "Github"
+ URL: "https://github.com/username/"
+ - Name: "LinkedIn"
+ URL: "https://www.linkedin.com/in/username/"
+```
### Sticky sidebar content