Update README.md
This commit is contained in:
parent
1745f76bbd
commit
23a2af3249
1 changed files with 11 additions and 3 deletions
14
README.md
14
README.md
|
@ -59,9 +59,13 @@ markup:
|
||||||
goldmark:
|
goldmark:
|
||||||
renderer:
|
renderer:
|
||||||
unsafe: true
|
unsafe: true
|
||||||
|
tableOfContents:
|
||||||
|
startLevel: 2
|
||||||
|
endLevel: 6
|
||||||
|
ordered: false
|
||||||
|
|
||||||
# Enable Google Analytics
|
# Enable Google Analytics
|
||||||
googleAnalytics: UA-xxxxxxxx
|
googleAnalytics: UA-XXXXXXXXX-X
|
||||||
|
|
||||||
# Enable Disqus forum
|
# Enable Disqus forum
|
||||||
disqusShortname: does-not-exist
|
disqusShortname: does-not-exist
|
||||||
|
@ -83,6 +87,9 @@ params:
|
||||||
# specify whether you want to write blog post or not
|
# specify whether you want to write blog post or not
|
||||||
enableBlogPost: true
|
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.
|
# 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.
|
# they will be separated by a divider from the main menus.
|
||||||
customMenus:
|
customMenus:
|
||||||
|
@ -92,6 +99,7 @@ params:
|
||||||
# some information about you
|
# some information about you
|
||||||
author:
|
author:
|
||||||
name: "Jane Doe"
|
name: "Jane Doe"
|
||||||
|
nickname: "Jane"
|
||||||
image: "images/avatar.png"
|
image: "images/avatar.png"
|
||||||
# give your some contact information. they will be used in the footer
|
# give your some contact information. they will be used in the footer
|
||||||
contactInfo:
|
contactInfo:
|
||||||
|
@ -192,7 +200,7 @@ Here, are the current plan and progress of various components of this theme. The
|
||||||
|
|
||||||
- [x] Post Cards
|
- [x] Post Cards
|
||||||
- [x] Sidebar
|
- [x] Sidebar
|
||||||
- [ ] Pagination
|
- [x] Pagination
|
||||||
|
|
||||||
### Reading Page
|
### 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] Next & Previous Page Navigation
|
||||||
- [x] `Improve This Page` Button
|
- [x] `Improve This Page` Button
|
||||||
- [x] Disqus Comment
|
- [x] Disqus Comment
|
||||||
- [ ] Option to navigate to list page
|
- [x] Option to navigate to list page
|
||||||
|
|
||||||
### Tracking and Comments
|
### Tracking and Comments
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue