aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md58
1 files changed, 38 insertions, 20 deletions
diff --git a/README.md b/README.md
index e4ee3c2..4ac177b 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,7 @@
![Screenshot](images/screenshot.png)
+
## Features
* Clean simple design
* Mobile friendly
@@ -10,6 +11,7 @@
* Designed to not interfere with main website
* Zero initial configuration
+
## Installation
Navigate to your hugo website root and run:
```
@@ -21,22 +23,40 @@ Then run hugo (or set `theme: book` in configuration file)
hugo server --theme book
```
-## Configuration
+
+## Menu
### File tree menu (default)
By default theme will render pages from `content/docs` section as menu in a tree structure.
You can set `title` and `weight` in front matter of pages to adjust order and titles in menu.
-
### Leaf bundle menu
You can also use leaf bundle and content of it's `index.md` as
-menu.
-Enable it by pointing to leaf bundle with `BookMenuBundle` parameter on Site level.
+menu.
+
+Given you have this file structure
+```
+├── content
+│ └── docs
+│ ├── page-one.md
+│ └── page-two.md
+```
+
+Create file `content/docs/menu/index.md` with content
+```md
+- [Book Example](/docs/)
+ - [Page One](/docs/page-one)
+ - [Page Two](/docs/page-two)
+```
+
+And Enable it by settings `BookMenuBundle: /docs/menu` in Site configuration
+
- [Example menu](exampleSite/content/menu)
- [Example config file](exampleSite/config.yml)
- [Leaf bundles](https://gohugo.io/content-management/page-bundles/)
-### Site configuration
+## Configuration
+### Site Configuration
There are few configuration options you can add to your `config.yml|json|toml` file
```yaml
# (Optional) Set this to true if you use captial letters in file names
@@ -47,9 +67,8 @@ params:
# You can also specify this parameter per page in front matter
BookShowToC: true
- # (Optional, default none) Set leaf bundle to render side menu
+ # (Optional, default none) Set leaf bundle to render as side menu
# When not specified file structure and weights will be used
- # See https://gohugo.io/content-management/page-bundles/
BookMenuBundle: /docs/menu
# (Optional, default docs) Specify section of content to render as menu
@@ -57,21 +76,20 @@ params:
BookSection: docs
```
-
-### Per document configuration
-You can specify additional params per document in front matter
+### Page Configuration
+You can specify additional params per page in front matter
```yaml
---
-# Set type to 'docs' if you want to render page outside of configured section
+# Set type to 'docs' if you want to render page outside of configured section or if you render section other than 'docs'
type: docs
# Set page weight to re-arrange items in file-tree menu (if BookMenuBundle not set)
weight: 10
-# Set to mark page as top level section in file-tree menu (if BookMenuBundle not set)
+# (Optional) Set to mark page as top level section in file-tree menu (if BookMenuBundle not set)
bookTopSection: true
-# Set to hide table of contents, overrides global value
+# (Optional) Set to hide table of contents, overrides global value
bookShowToC: false
---
```
@@ -79,12 +97,12 @@ bookShowToC: false
### Partials
There are few empty partials you can override in `layouts/partials/`
-| Partial | Placement |
-| -- | -- |
-| layouts/partials/docs/inject/head.html | Before closing `<head>` tag |
-| layouts/partials/docs/inject/body.html | Before closing `<body>` tag |
-| layouts/partials/docs/inject/nav-before.html | Before `<nav>` menu block |
-| layouts/partials/docs/inject/nav-after.html | After `<nav>` menu block |
+| Partial | Placement |
+| -- | -- |
+| `layouts/partials/docs/inject/head.html` | Before closing `<head>` tag |
+| `layouts/partials/docs/inject/body.html` | Before closing `<body>` tag |
+| `layouts/partials/docs/inject/nav-before.html` | Before `<nav>` menu block |
+| `layouts/partials/docs/inject/nav-after.html` | After `<nav>` menu block |
## Contributing
@@ -94,7 +112,7 @@ Primary goals are:
- Keep minimal (or zero) default configuration
- Avoid interference with user-defined layouts
-If you missing some configuration or customisation option feel free to open issue.
+Feel free to open issue if you missing some configuration or customisation option.
## License
[MIT](LICENSE) \ No newline at end of file