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

github.com/alex-shpak/hugo-book.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlex Shpak <alex-shpak@users.noreply.github.com>2019-10-09 01:05:30 +0300
committerAlex Shpak <alex-shpak@users.noreply.github.com>2019-10-09 01:05:30 +0300
commit071e069d929df9b8bf50f6ab31d69e10bcf5c892 (patch)
treeacdb95354497b2b7ae8ed1b45b0a710a73e0822c /README.md
parentc7f93dc789da16ff03fa37b1c14ccc03c80e6b0a (diff)
Update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/README.md b/README.md
index c438129..388469b 100644
--- a/README.md
+++ b/README.md
@@ -8,8 +8,10 @@
![Screenshot](https://github.com/alex-shpak/hugo-book/blob/master/images/screenshot.png)
- [Features](#features)
+- [Requirements](#requirements)
- [Installation](#installation)
- [Menu](#menu)
+- [Blog](#blog)
- [Configuration](#configuration)
- [Shortcodes](#shortcodes)
- [Contributing](#contributing)
@@ -17,7 +19,7 @@
## Features
- Clean simple design
-- Mobile friendly
+- Light and Mobile-Friendly
- Customisable
- Designed to not interfere with other layouts
- Zero initial configuration
@@ -86,10 +88,10 @@ Create file `content/docs/menu/index.md` with content
headless = true
+++
-- [Book Example](/docs/)
- - [Page One](/docs/page-one)
- - [Page Two](/docs/page-two)
-- [Blog](/posts)
+- [Book Example]({{< relref "/docs/" >}})
+ - [Page One]({{< relref "/docs/page-one" >}})
+ - [Page Two]({{< relref "/docs/page-two" >}})
+- [Blog]({{< relref "/posts" >}})
```
And Enable it by settings `BookMenuBundle: /menu` in Site configuration