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

github.com/parsiya/Hugo-Octopress.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorparsiya@gmail.com <parsiya@gmail.com>2016-08-25 08:35:24 +0300
committerparsiya@gmail.com <parsiya@gmail.com>2016-08-25 08:35:24 +0300
commitfd8aee92348ddfd7c8f45366693b33e0b450d31c (patch)
treef77ec357e340396c6f4bb9ba8cf47a4e02d1eb9d
parentf843be89e1dca6238269b571573a05fa0ecc24ad (diff)
Fix identation problem in README to display code properly when rendered on github
-rw-r--r--README.md17
1 files changed, 10 insertions, 7 deletions
diff --git a/README.md b/README.md
index 929f230..00185f2 100644
--- a/README.md
+++ b/README.md
@@ -342,16 +342,19 @@ There are two ways to enable Table of Contents:
* Each post/page can have a variable named `toc` in its frontmatter. This needs to be set to `true`.
-
- title: "title"
- date: 2016-04-01T20:22:37-04:00
- draft: false
- toc: true
+```
+title: "title"
+date: 2016-04-01T20:22:37-04:00
+draft: false
+toc: true
+```
* Global setting is available in the config file, `tableOfContents` under `[Params]` need to be set to `true`.
- [Params]
- tableOfContents = true
+```
+[Params]
+ tableOfContents = true
+```
The `toc` variable in frontmatter has priority. If it is set `false` then the config file is ignored. It is recommended to not set use the config file and enable the ToC for individual pages. Otherwise, it can be enabled for all pages in the config file and disabled for specific pages using the frontmatter.