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

github.com/yoshiharuyamashita/blackburn.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorYoshiharu Yamashita <yoshiharu.yamashita@outlook.com>2016-01-30 23:50:53 +0300
committerYoshiharu Yamashita <yoshiharu.yamashita@outlook.com>2016-01-30 23:50:53 +0300
commit69bd6a9c416dfb4b4cf1610533160b0a63397303 (patch)
tree55219e0a712903738626cb722696e480d845dcef /README.md
parentf42e2400a65e150c408bf27661e66ef4dac92827 (diff)
Update readme and sample config.toml
Diffstat (limited to 'README.md')
-rw-r--r--README.md38
1 files changed, 33 insertions, 5 deletions
diff --git a/README.md b/README.md
index 04d302e..92d3d9e 100644
--- a/README.md
+++ b/README.md
@@ -63,6 +63,32 @@ paginate = 10
# CSS name for highlight.js
highlightjs = "androidstudio"
+[menu]
+ # Shown in the side menu.
+ [[menu.main]]
+ name = "Home"
+ pre = "<i class='fa fa-home fa-fw'></i>"
+ weight = 0
+ identifier = "home"
+ url = "/"
+ [[menu.main]]
+ name = "Posts"
+ pre = "<i class='fa fa-list fa-fw'></i>"
+ weight = 1
+ identifier = "post"
+ url = "/post/"
+ [[menu.main]]
+ name = "About"
+ pre = "<i class='fa fa-user fa-fw'></i>"
+ weight = 2
+ identifier = "about"
+ url = "/about/"
+ [[menu.main]]
+ name = "Contact"
+ pre = "<i class='fa fa-phone fa-fw'></i>"
+ weight = 3
+ url = "/contact/"
+
[social]
# Link your social networking accouns to the side menu
# by entering your username or ID.
@@ -77,13 +103,15 @@ paginate = 10
## Usage
* Write Markdown files in `content/post`
-* Add fixed pages (e.g., about.md) to the side menu by creating them in `content` and setting `sidemenu` to `true` in its front matter:
+* Add fixed pages (e.g., about.md) to the side menu by defining them under `[menu]` in the config.toml:
```toml
-title = "About"
-date = "2014-04-09"
-sidemenu = "true"
-description = "About me and this site"
+[[menu.main]]
+ name = "About"
+ pre = "<i class='fa fa-user fa-fw'></i>"
+ weight = 2
+ identifier = "about"
+ url = "/about/"
```
## License