adoralaura/hugo-book-theme
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Alex Shpak 2018-09-17 15:33:04 +02:00
parent 73f26ca60d
commit 0dec1cd3a8
1 changed files with 38 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
README.md
View file

@ -3,6 +3,7 @@
![Screenshot](images/screenshot.png) ![Screenshot](images/screenshot.png)
## Features ## Features
* Clean simple design * Clean simple design
* Mobile friendly * Mobile friendly
@ -10,6 +11,7 @@
* Designed to not interfere with main website * Designed to not interfere with main website
* Zero initial configuration * Zero initial configuration
## Installation ## Installation
Navigate to your hugo website root and run: 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 hugo server --theme book
``` ```
## Configuration
## Menu
### File tree menu (default) ### File tree menu (default)
By default theme will render pages from `content/docs` section as menu in a tree structure. 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. You can set `title` and `weight` in front matter of pages to adjust order and titles in menu.
### Leaf bundle menu ### Leaf bundle menu
You can also use leaf bundle and content of it's `index.md` as You can also use leaf bundle and content of it's `index.md` as
menu. menu.
Enable it by pointing to leaf bundle with `BookMenuBundle` parameter on Site level.
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 menu](exampleSite/content/menu)
- [Example config file](exampleSite/config.yml) - [Example config file](exampleSite/config.yml)
- [Leaf bundles](https://gohugo.io/content-management/page-bundles/) - [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 There are few configuration options you can add to your `config.yml|json|toml` file
```yaml ```yaml
# (Optional) Set this to true if you use captial letters in file names # (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 # You can also specify this parameter per page in front matter
BookShowToC: true 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 # When not specified file structure and weights will be used
# See https://gohugo.io/content-management/page-bundles/
BookMenuBundle: /docs/menu BookMenuBundle: /docs/menu
# (Optional, default docs) Specify section of content to render as menu # (Optional, default docs) Specify section of content to render as menu
@ -57,21 +76,20 @@ params:
BookSection: docs BookSection: docs
``` ```
### Page Configuration
### Per document configuration You can specify additional params per page in front matter
You can specify additional params per document in front matter
```yaml ```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 type: docs
# Set page weight to re-arrange items in file-tree menu (if BookMenuBundle not set) # Set page weight to re-arrange items in file-tree menu (if BookMenuBundle not set)
weight: 10 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 bookTopSection: true
# Set to hide table of contents, overrides global value # (Optional) Set to hide table of contents, overrides global value
bookShowToC: false bookShowToC: false
--- ---
``` ```
@ -79,12 +97,12 @@ bookShowToC: false
### Partials ### Partials
There are few empty partials you can override in `layouts/partials/` There are few empty partials you can override in `layouts/partials/`
| Partial | Placement | | Partial | Placement |
| -- | -- | | -- | -- |
| layouts/partials/docs/inject/head.html | Before closing `<head>` tag | | `layouts/partials/docs/inject/head.html` | Before closing `<head>` tag |
| layouts/partials/docs/inject/body.html | Before closing `<body>` 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-before.html` | Before `<nav>` menu block |
| layouts/partials/docs/inject/nav-after.html | After `<nav>` menu block | | `layouts/partials/docs/inject/nav-after.html` | After `<nav>` menu block |
## Contributing ## Contributing
@ -94,7 +112,7 @@ Primary goals are:
- Keep minimal (or zero) default configuration - Keep minimal (or zero) default configuration
- Avoid interference with user-defined layouts - 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 ## License
[MIT](LICENSE) [MIT](LICENSE)