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

github.com/hossainemruz/toha.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMd. Emruz Hossain <hossainemruz@gmail.com>2020-07-22 01:14:08 +0300
committerGitHub <noreply@github.com>2020-07-22 01:14:08 +0300
commitfa4d47497403491cff184d226a5b2a07ad5dc081 (patch)
tree9dd7afb7c54f83533361282e4ecd011d59cbecf2 /README.md
parent647578e88be55c5cbb2eda157e17242f56ee5630 (diff)
Refactor sidebar logic + Add Table of Contents in reading page (#33)
* Refactor sidebar logic + fix responsiveness * Add TOC * Add Pagination * Update exampleSite * Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.md b/README.md
index 5215263..5ea8696 100644
--- a/README.md
+++ b/README.md
@@ -59,9 +59,13 @@ markup:
goldmark:
renderer:
unsafe: true
+ tableOfContents:
+ startLevel: 2
+ endLevel: 6
+ ordered: false
# Enable Google Analytics
-googleAnalytics: UA-xxxxxxxx
+googleAnalytics: UA-XXXXXXXXX-X
# Enable Disqus forum
disqusShortname: does-not-exist
@@ -83,6 +87,9 @@ params:
# specify whether you want to write blog post or not
enableBlogPost: true
+ # specify whether you want to show Table of Contents in reading page
+ enableTOC: true
+
# specify the list of custom menus that you want to show in the top navbar.
# they will be separated by a divider from the main menus.
customMenus:
@@ -92,6 +99,7 @@ params:
# some information about you
author:
name: "Jane Doe"
+ nickname: "Jane"
image: "images/avatar.png"
# give your some contact information. they will be used in the footer
contactInfo:
@@ -192,7 +200,7 @@ Here, are the current plan and progress of various components of this theme. The
- [x] Post Cards
- [x] Sidebar
-- [ ] Pagination
+- [x] Pagination
### Reading Page
@@ -201,7 +209,7 @@ Here, are the current plan and progress of various components of this theme. The
- [x] Next & Previous Page Navigation
- [x] `Improve This Page` Button
- [x] Disqus Comment
-- [ ] Option to navigate to list page
+- [x] Option to navigate to list page
### Tracking and Comments