Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/progrhyme/hugo-theme-bootie-docs.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorkey-amb <yasutake.kiyoshi@gmail.com>2017-03-05 04:35:34 +0300
committerkey-amb <yasutake.kiyoshi@gmail.com>2017-03-05 04:35:34 +0300
commit234127a76b0fac92be9f4575b45ca37359531de8 (patch)
treef18cb307d7fe8f89d39a4f0eb6ec5ed4c4ced165
parent5b14e4081c0d6d591150df486f558640f8c7c8be (diff)
Update README about change of Menu System
-rw-r--r--README.md32
1 files changed, 22 insertions, 10 deletions
diff --git a/README.md b/README.md
index 4827f8b..7c9cf1d 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,7 @@ You can see demo and full documentation at http://key-amb.github.io/bootie-docs-
## CONTENTS
* [QUICKSTART](#quickstart)
+* [MENUS](#menus)
* [OPTIONS](#options)
* [LIMITATION](#limitation)
* [DEPENDENCIES](#dependencies)
@@ -22,29 +23,40 @@ You can see demo and full documentation at http://key-amb.github.io/bootie-docs-
Then the content appears on top page.
-## OPTIONS
+## MENUS
-You can customize the menu items in the header navigation bar by configuring `params.mainMenu` in your _config.toml_ (or _config.yaml_).
+You can customize the menu items in the header navigation bar by configuring `menu.main` in your
+_config.toml_ (or _config.yaml_) supported by Hugo's [Menu System](https://gohugo.io/extras/menus/).
```
# example of config.toml
[params]
highlightStyle = "github"
-[[params.mainMenu]]
- name = "Usage"
- link = "usage"
+[[menu.main]]
+ name = "Usage"
+ url = "/usage/"
+ weight = 10
-[[params.mainMenu]]
- name = "News"
- link = "categories/news"
+[[menu.main]]
+ name = "News"
+ url = "/categories/news/"
+ weight = 20
```
-All other options and usages are described at the documentation site -- http://key-amb.github.io/bootie-docs-demo/ .
+NOTE:
+
+- Nested menus are not supported.
+
+## OPTIONS
+
+All other options and usages for _Bootie Docs_ are described at the documentation site --
+http://key-amb.github.io/bootie-docs-demo/ .
## LIMITATION
-Because _Bootie Docs_ is developed for documentation, it lacks many blog-type facilities such as RSS feeds, pagination of posts and so on.
+Because _Bootie Docs_ is developed for documentation, it lacks many blog-type facilities such as RSS
+feeds, pagination of posts and so on.
## DEPENDENCIES