diff options
author | Thibaud Lepretre <thibaud.lepretre@gmail.com> | 2017-11-26 22:10:54 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2017-11-26 22:10:54 +0300 |
commit | 36cb59bdebb0cbebbbf2b554fd900f854dc1d3ec (patch) | |
tree | 4bee6b42c7a0aa91f236415446c0edf7b2b77018 /docs | |
parent | 3d924358dc388f241087d0e75f4471888075f273 (diff) | |
parent | ae94ecc7fd1c4f9b96e9568049ff219c6fba4af8 (diff) |
Merge pull request #233 from zacbook/develop
Add custom summary / excerpt feature
Diffstat (limited to 'docs')
-rw-r--r-- | docs/user.md | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/docs/user.md b/docs/user.md index f248e3e..b5e57f6 100644 --- a/docs/user.md +++ b/docs/user.md @@ -541,7 +541,8 @@ Please note, there are many different versions of Markdown and some of them are Tranquilpeak introduces new variables to give you a lot of possibilities. Example : -``` markdown + +```markdown disqusIdentifier: fdsF34ff34 keywords: - javascript @@ -566,6 +567,7 @@ showTags: true showPagination: true showSocial: true showDate: true +summary: "This is a custom summary and does *not* appear in the post." ``` |Variable|Description| @@ -589,6 +591,7 @@ showDate: true |showSocial|`true`: show social button such as share on Twitter, Facebook...| |showMeta|`true`: Show post meta (date, categories).| |showActions|`true`: Show post actions (navigation, share links).| +|summary|Custom excerpt text to show on the homepage.| Example: A post on index page will look like this with :`thumbnailImagePosition` set to `bottom`: @@ -605,6 +608,7 @@ The same with : `thumbnailImagePosition` set to `left`: Use: - `<!--more-->` to define post excerpt and keep the post excerpt in the post content +- For a custom exerpt *not* in the post content, use the `summary` front-matter variable. Markdown syntax is supported. ### Display table of contents |