Update readme
This commit is contained in:
parent
c7f93dc789
commit
071e069d92
1 changed files with 7 additions and 5 deletions
12
README.md
12
README.md
|
@ -8,8 +8,10 @@
|
||||||
![Screenshot](https://github.com/alex-shpak/hugo-book/blob/master/images/screenshot.png)
|
![Screenshot](https://github.com/alex-shpak/hugo-book/blob/master/images/screenshot.png)
|
||||||
|
|
||||||
- [Features](#features)
|
- [Features](#features)
|
||||||
|
- [Requirements](#requirements)
|
||||||
- [Installation](#installation)
|
- [Installation](#installation)
|
||||||
- [Menu](#menu)
|
- [Menu](#menu)
|
||||||
|
- [Blog](#blog)
|
||||||
- [Configuration](#configuration)
|
- [Configuration](#configuration)
|
||||||
- [Shortcodes](#shortcodes)
|
- [Shortcodes](#shortcodes)
|
||||||
- [Contributing](#contributing)
|
- [Contributing](#contributing)
|
||||||
|
@ -17,7 +19,7 @@
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Clean simple design
|
- Clean simple design
|
||||||
- Mobile friendly
|
- Light and Mobile-Friendly
|
||||||
- Customisable
|
- Customisable
|
||||||
- Designed to not interfere with other layouts
|
- Designed to not interfere with other layouts
|
||||||
- Zero initial configuration
|
- Zero initial configuration
|
||||||
|
@ -86,10 +88,10 @@ Create file `content/docs/menu/index.md` with content
|
||||||
headless = true
|
headless = true
|
||||||
+++
|
+++
|
||||||
|
|
||||||
- [Book Example](/docs/)
|
- [Book Example]({{< relref "/docs/" >}})
|
||||||
- [Page One](/docs/page-one)
|
- [Page One]({{< relref "/docs/page-one" >}})
|
||||||
- [Page Two](/docs/page-two)
|
- [Page Two]({{< relref "/docs/page-two" >}})
|
||||||
- [Blog](/posts)
|
- [Blog]({{< relref "/posts" >}})
|
||||||
```
|
```
|
||||||
|
|
||||||
And Enable it by settings `BookMenuBundle: /menu` in Site configuration
|
And Enable it by settings `BookMenuBundle: /menu` in Site configuration
|
||||||
|
|
Loading…
Reference in a new issue