feat: add the post.readMoreFromContent parameter

Read more from content after clicking the read more button if enabled
razonyang · Sep 7, 2022 · 5b6ee76 · 5b6ee76
1 parent 13a9124
commit 5b6ee76
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 7 deletions.
diff --git a/exampleSite/config/_default/params.toml b/exampleSite/config/_default/params.toml
@@ -102,6 +102,9 @@ viewer = true # Image Viewer
   imageTitleAsCaption = true
   # panel = false # Disable the post panel.
   # nav = false # Disable post navigations.
+  # The page position after clicking the read more button, read more from content if true. Default to the beginning of page.
+  # It supports only of the manual summaries spliting via <!--more-->.
+  # readMoreFromContent = true
 
 [archive]
   # basePath = "/archiv" # The base path of archive pages.

diff --git a/exampleSite/content/docs/configuration/site-params/index.md b/exampleSite/content/docs/configuration/site-params/index.md
@@ -128,6 +128,7 @@ The site parameters are located in `config/_default/params.toml` by default.
 | `post.imageTitleAsCaption` | Boolean | `false` | Use image title as caption.
 | `post.panel` | Boolean | `true` | Turn on/off the post panel.
 | `post.nav` | Boolean | `true` | Turn on/off the navigations.
+| `post.readMoreFromContent` | Boolean | `false` | The page position after clicking the read more button, read more from content if true. Default to the beginning of page. It supports only of the manual summaries spliting via `<!--more-->`.
 | `viewer` | Boolean | true | [Image Viewer]({{< ref "docs/image-viewer" >}})
 | `pwa` | Object | - | [Progressive Web Apps]({{< ref "/docs/pwa" >}})
 | **Sidebar**

diff --git a/exampleSite/content/docs/configuration/site-params/index.zh-hans.md b/exampleSite/content/docs/configuration/site-params/index.zh-hans.md
@@ -131,6 +131,7 @@ authors = ["RazonYang"]
 | `post.imageTitleAsCaption` | Boolean | `false` | 将图片标题作为 caption。
 | `post.panel` | Boolean | `true` | 是否显示 post panel。
 | `post.nav` | Boolean | `true` | 是否顯示上一篇和下一篇。
+| `post.readMoreFromContent` | Boolean | `false` | The page position after clicking the read more button, read more from content if true. Default to the beginning of page. It supports only of the manual summaries spliting via `<!--more-->`.
 | `viewer` | Boolean | true | [图片查看器]({{< ref "docs/image-viewer" >}})
 | `pwa` | Object | - | [渐进式 web 应用]({{< ref "/docs/pwa" >}})
 | **Sidebar**

diff --git a/exampleSite/content/docs/configuration/site-params/index.zh-hant.md b/exampleSite/content/docs/configuration/site-params/index.zh-hant.md
@@ -131,6 +131,7 @@ authors = ["RazonYang"]
 | `post.imageTitleAsCaption` | Boolean | `false` | 将图片标题作为 caption。
 | `post.panel` | Boolean | `true` | 是否顯示 post panel。
 | `post.nav` | Boolean | `true` | 是否顯示上一篇和下一篇。
+| `post.readMoreFromContent` | Boolean | `false` | The page position after clicking the read more button, read more from content if true. Default to the beginning of page. It supports only of the manual summaries spliting via `<!--more-->`.
 | `viewer` | Boolean | true | [圖片查看器]({{< ref "docs/image-viewer" >}})
 | `pwa` | Object | - | [漸進式 web 應用]({{< ref "/docs/pwa" >}})
 | **Sidebar**

diff --git a/layouts/partials/docs/post.html b/layouts/partials/docs/post.html
@@ -8,9 +8,7 @@ <h1 class="card-title post-title my-2">{{ partial "helpers/title" . }}</h1>
     {{- partial "post/featured-image" . -}}
     {{- partial "hooks/content-begin" . -}}
     {{- partial "post/toc-wrapper" . -}}
-    <div class="post-content mb-3" data-bs-spy="scroll" data-bs-target="#TableOfContents" tabindex="0">
-    {{- .Content -}}
-    </div>
+    {{- partial "post/content" . -}}
     {{- partial "post/reward" . -}}
     {{- partial "hooks/content-end" . -}}
 </div>

diff --git a/layouts/partials/post.html b/layouts/partials/post.html
@@ -13,9 +13,7 @@ <h1 class="card-title post-title my-2">{{ partial "helpers/title" . }}</h1>
       {{- partial "post/toc-wrapper" . -}}
     {{- end -}}
     {{- partial "post/share" . -}}
-    <div class="post-content mb-3" data-bs-spy="scroll" data-bs-target="#TableOfContents" tabindex="0">
-      {{- .Content -}}
-    </div>
+    {{- partial "post/content" . -}}
     {{- partial "post/reward" . -}}
     {{- partial "hooks/content-end" . -}}
   </div>

diff --git a/layouts/partials/post/content.html b/layouts/partials/post/content.html
@@ -0,0 +1,8 @@
+<div class="post-content mb-3" data-bs-spy="scroll" data-bs-target="#TableOfContents" tabindex="0">
+    {{- if default false $.Site.Params.post.readMoreFromContent }}
+        {{- with .Summary }}<div id="post-summary">{{ . }}</div>{{ end }}
+        <div id="post-content-body">{{- strings.TrimPrefix .Summary .Content | safeHTML -}}</div>
+    {{- else }}
+        <div id="post-content-body">{{ .Content }}</div>
+    {{- end }}
+</div>
diff --git a/layouts/partials/post/excerpt.html b/layouts/partials/post/excerpt.html
@@ -1,6 +1,8 @@
 {{- $key := $.Site.Params.post.excerpt }}
 {{- $useDescription := and (eq $key "description") .Description }}
-{{- $readMoreButton := printf "<div><a class=\"btn btn-sm btn-outline-primary btn-read-more\" href=\"%s\">%s</a></div>" .Permalink (i18n "read_more") | safeHTML }}
+{{- $anchor := "" }}
+{{- if default false $.Site.Params.post.readMoreFromContent }}{{ $anchor = "#post-content-body" }}{{ end }}
+{{- $readMoreButton := printf "<div><a class=\"btn btn-sm btn-outline-primary btn-read-more\" href=\"%s%s\">%s</a></div>" .Permalink $anchor (i18n "read_more") | safeHTML }}
 {{- $content :=  "" }}
 {{- $readMore := true }}
 {{- if $useDescription }}