summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlex Shpak <alex-shpak@users.noreply.github.com>2019-01-24 22:54:33 +0100
committerAlex Shpak <alex-shpak@users.noreply.github.com>2019-01-24 22:54:33 +0100
commitd746c8eec369cc76fb9937f7838172ba40d3bf0f (patch)
tree57ba842d344726260978e2c93d2cdd3393f27d9b /README.md
parent0179d7f2bca0cb8a2116ccac825030e2aaf21a2e (diff)
#17, Add note that blog rendered via 'posts' type
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 11 insertions, 5 deletions
diff --git a/README.md b/README.md
index b46b9ee..d6df0cd 100644
--- a/README.md
+++ b/README.md
@@ -9,7 +9,7 @@
* Clean simple design
* Mobile friendly
* Customizable
-* Designed to not interfere with main website
+* Designed to not interfere with other layouts
* Zero initial configuration
## Requirements
@@ -39,9 +39,12 @@ menu.
Given you have this file structure
```
├── content
-│ └── docs
-│ ├── page-one.md
-│ └── page-two.md
+│ ├── docs
+│ │ ├── page-one.md
+│ │ └── page-two.md
+│ └── posts
+│ ├── post-one.md
+│ └── post-two.md
```
Create file `content/docs/menu/index.md` with content
@@ -53,6 +56,7 @@ headless: true
- [Book Example](/docs/)
- [Page One](/docs/page-one)
- [Page Two](/docs/page-two)
+- [Blog](/posts)
```
And Enable it by settings `BookMenuBundle: /docs/menu` in Site configuration
@@ -61,6 +65,8 @@ And Enable it by settings `BookMenuBundle: /docs/menu` in Site configuration
- [Example config file](https://github.com/alex-shpak/hugo-book/blob/master/exampleSite/config.yml)
- [Leaf bundles](https://gohugo.io/content-management/page-bundles/)
+## Blog
+Simple blog supported for section `posts`
## Configuration
### Site Configuration
@@ -133,7 +139,7 @@ Primary goals are:
- Keep minimal (or zero) default configuration
- Avoid interference with user-defined layouts
-Feel free to open issue if you missing some configuration or customisation option.
+Feel free to open issue if you missing some configuration or customization option.
## License
[MIT](LICENSE)