feat(home): improve default behavior of hiddenFromHomePage

2024-09-20 00:52:49 +02:00 · 2020-02-17 12:44:04 +08:00 · 2020-02-17 12:44:04 +08:00 · a276661f0a
commit a276661f0a
parent dd78d80fef
12 changed files with 73 additions and 102 deletions
--- a/archetypes/default.md
+++ b/archetypes/default.md
@ -1,25 +1,24 @@
 ---
-author: ""
-author_link: ""
 title: "{{ replace .TranslationBaseName "-" " " | title }}"
 date: {{ .Date }}
 lastmod: {{ .Date }}
 draft: true
+author: ""
+authorLink: ""
 description: ""
-show_in_homepage: true
-description_as_summary: false
 license: ""

 tags: []
 categories: []
+hiddenFromHomePage: false

-featured_image: ""
-featured_image_preview: ""
+featuredImage: ""
+featuredImagePreview: ""

-comment: true
 toc: false
-auto_collapse_toc: true
+autoCollapseToc: true
 math: false
+comment: true
 ---

-<!--more-->
+<!--more-->
--- a/exampleSite/config.toml
+++ b/exampleSite/config.toml
@ -151,6 +151,8 @@ dateFormatToUse = "2006-01-02"
      enable = true
      # special amount of posts in each home posts page
      paginate = 6
+      # default behavior when you don't set "hiddenFromHomePage" in front matter
+      defaultHiddenFromHomePage = false

  # Social Info in home page
  [params.social]
--- a/exampleSite/content/posts/emoji-support.md
+++ b/exampleSite/content/posts/emoji-support.md
@ -1,29 +1,24 @@
 ---
-author: "Hugo Authors"
-author_link: "https://gohugo.io/"
 title: "Emoji Support"
 date: 2019-10-01T17:55:28+08:00
 lastmod: 2019-10-01T17:55:28+08:00
 draft: false
+author: "Hugo Authors"
+authorLink: "https://gohugo.io/"
 description: "Guide to emoji usage in Hugo"
-show_in_homepage: true
-description_as_summary: false
 license: ""

-tags: [
-  "emoji",
-]
-categories: [
-  "theme",
-]
+tags: ["emoji"]
+categories: ["theme"]
+hiddenFromHomePage: false

-featured_image: /images/emoji.jpg
-featured_image_preview: ""
+featuredImage: /images/emoji.jpg
+featuredImagePreview: ""

-comment: true
 toc: false
-auto_collapse_toc: true
+autoCollapseToc: true
 math: false
+comment: true
 ---

 Emoji can be enabled in a Hugo project in a number of ways.
--- a/exampleSite/content/posts/markdown-syntax.md
+++ b/exampleSite/content/posts/markdown-syntax.md
@ -1,31 +1,24 @@
 ---
-author: "Hugo Authors"
-author_link: "https://gohugo.io/"
 title: "Markdown Syntax Guide"
 date: 2019-12-01T21:57:40+08:00
 lastmod: 2020-01-01T16:45:40+08:00
 draft: false
+author: "Hugo Authors"
+authorLink: "https://gohugo.io/"
 description: "Sample article showcasing basic Markdown syntax and formatting for HTML elements."
-show_in_homepage: true
-description_as_summary: false
 license: ""

-tags: [
-    "markdown",
-    "css",
-    "html",
-]
-categories: [
-    "theme",
-]
+tags: ["markdown", "css", "html"]
+categories: ["theme"]
+hiddenFromHomePage: false

-featured_image: /images/markdown.png
-featured_image_preview: ""
+featuredImage: /images/markdown.png
+featuredImagePreview: ""

-comment: true
 toc: true
-auto_collapse_toc: true
+autoCollapseToc: true
 math: true
+comment: true
 ---

 This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme.
--- a/exampleSite/content/posts/placeholder-text.md
+++ b/exampleSite/content/posts/placeholder-text.md
@ -1,30 +1,24 @@
 ---
-author: "Hugo Authors"
-author_link: "https://gohugo.io/"
 title: "Placeholder Text"
 date: 2019-08-01T18:02:41+08:00
 lastmod: 2019-08-01T18:02:41+08:00
 draft: false
+author: "Hugo Authors"
+authorLink: "https://gohugo.io/"
 description: "Lorem Ipsum Dolor Si Amet"
-show_in_homepage: true
-description_as_summary: false
 license: ""

-tags: [
-  "markdown",
-  "text",
-]
-categories: [
-  "theme",
-]
+tags: ["markdown", "text"]
+categories: ["theme"]
+hiddenFromHomePage: false

-featured_image: ""
-featured_image_preview: ""
+featuredImage: ""
+featuredImagePreview: ""

-comment: true
 toc: false
-auto_collapse_toc: true
+autoCollapseToc: true
 math: false
+comment: true
 ---

 Lorem est tota propiore conpellat pectoribus de
--- a/exampleSite/content/posts/rich-content.md
+++ b/exampleSite/content/posts/rich-content.md
@ -1,30 +1,24 @@
 ---
-author: "Hugo Authors"
-author_link: "https://gohugo.io/"
 title: "Rich Content"
 date: 2019-09-01T18:06:32+08:00
 lastmod: 2019-09-01T18:06:32+08:00
 draft: false
+author: "Hugo Authors"
+authorLink: "https://gohugo.io/"
 description: "A brief description of Hugo Shortcodes"
-show_in_homepage: true
-description_as_summary: false
 license: ""

-tags: [
-    "shortcodes",
-    "privacy",
-]
-categories: [
-  "theme",
-]
+tags: ["shortcodes", "privacy"]
+categories: ["theme"]
+hiddenFromHomePage: false

-featured_image: /images/hugo.png
-featured_image_preview: ""
+featuredImage: /images/hugo.png
+featuredImagePreview: ""

-comment: true
 toc: false
-auto_collapse_toc: true
+autoCollapseToc: true
 math: false
+comment: true
 ---

 Hugo ships with several [Built-in Shortcodes](https://gohugo.io/content-management/shortcodes/#use-hugo-s-built-in-shortcodes) for rich content, along with a [Privacy Config](https://gohugo.io/about/hugo-and-gdpr/) and a set of Simple Shortcodes that enable static and no-JS versions of various social media embeds.
--- a/exampleSite/zh/config.toml
+++ b/exampleSite/zh/config.toml
@ -151,6 +151,8 @@ dateFormatToUse = "2006-01-02"
      enable = true
      # 主页每页显示文章数量
      paginate = 6
+      # 当你没有在文章前面设置 "hiddenFromHomePage" 时的默认行为
+      defaultHiddenFromHomePage = false

  # 主页的社交信息设置
  [params.social]
--- a/exampleSite/zh/content/posts/Basic-Markdown-Preview.md
+++ b/exampleSite/zh/content/posts/Basic-Markdown-Preview.md
@ -1,30 +1,24 @@
 ---
-author: ""
-author_link: ""
 title: "Markdown 基本语法预览"
 date: 2019-08-25T16:22:42+08:00
 lastmod: 2019-08-25T16:22:42+08:00
 draft: false
+author: ""
+authorLink: ""
 description: "这是一篇用于预览 Markdown 基本语法的文章。"
-show_in_homepage: true
-description_as_summary: false
 license: ""

-tags: [
-    "Hugo",
-    "主题",
-]
-categories: [
-    "预览",
-]
+tags: ["Hugo", "主题"]
+categories: ["预览"]

-featured_image: ""
-featured_image_preview: ""
+featuredImage: ""
+featuredImagePreview: ""
+hiddenFromHomePage: false

-comment: true
 toc: true
-auto_collapse_toc: true
+autoCollapseToc: true
 math: true
+comment: true
 ---

 这是一篇用于预览 :(fab fa-markdown): Markdown 基本语法的文章。
--- a/layouts/_default/summary.html
+++ b/layouts/_default/summary.html
@ -1,8 +1,8 @@
 <article class="single summary" itemscope itemtype="http://schema.org/Article">
    {{- /* Featured image */ -}}
-    {{- with .Params.featured_image -}}
+    {{- with .Params.featuredImage -}}
        <div class="featured-image-preview">
-            {{- $image := $.Params.featured_image_preview | default . -}}
+            {{- $image := $.Params.featuredImagePreview | default . -}}
            {{- partial "hook/image" $image -}}
        </div>
    {{- end -}}
@ -15,8 +15,8 @@
    {{- /* Meta */ -}}
    <div class="meta">
        {{- $author := .Params.author | default .Site.Author.name -}}
-        {{- $author_link := .Params.author_link | default .Site.Author.link | default .Site.BaseURL -}}
-        <a class="author" href="{{ $author_link }}" rel="author" target="_blank">
+        {{- $authorLink := .Params.authorLink | default .Site.Author.link | default .Site.BaseURL -}}
+        <a class="author" href="{{ $authorLink }}" rel="author" target="_blank">
            <i class="fas fa-user-circle fa-fw"></i>{{ $author }}
        </a>

@ -39,13 +39,7 @@

    {{- /* Summary content */ -}}
    <div class="content">
-        {{- if .Params.description_as_summary -}}
-            <p>
-                {{- .Params.description -}}
-            </p>
-        {{- else -}}
-            {{- partial "hook/content.html" .Summary | safeHTML -}}
-        {{- end -}}
+        {{- partial "hook/content.html" .Summary | safeHTML -}}
    </div>

    {{- /* Footer */ -}}
--- a/layouts/index.html
+++ b/layouts/index.html
@ -9,7 +9,11 @@
        {{- if .Site.Params.home.posts.enable -}}
            {{- /* Paginate */ -}}
            {{- $paginator := where .Site.RegularPages "Type" "posts" -}}
-            {{- $paginator = where $paginator "Params.show_in_homepage" "!=" false -}}
+            {{- if ne .Site.Params.home.posts.mode.defaultHiddenFromHomePage false -}}
+                {{- $paginator = where $paginator "Params.hiddenfromhomepage" "!=" true -}}
+            {{- else -}}
+                {{- $paginator = where $paginator "Params.hiddenfromhomepage" false -}}
+            {{- end -}}
            {{- with .Site.Params.home.posts.paginate -}}
                {{- $paginator = $.Paginate $paginator . -}}
            {{- else -}}
--- a/layouts/partials/post/share.html
+++ b/layouts/partials/post/share.html
@ -64,7 +64,7 @@

    {{- /* Share on Weibo */ -}}
    {{- if .Params.Share.Weibo | default .Site.Params.Share.Weibo | eq true -}}
-        <a href="//service.weibo.com/share/share.php?url={{ .Permalink }}&amp;appkey=&amp;title={{ .Title }}{{ with $.Params.featured_image }}&amp;pic={{ . }}{{- end -}}" target="_blank" title="{{ T "share" }} Weibo">
+        <a href="//service.weibo.com/share/share.php?url={{ .Permalink }}&amp;appkey=&amp;title={{ .Title }}{{ with $.Params.featuredImage }}&amp;pic={{ . }}{{- end -}}" target="_blank" title="{{ T "share" }} Weibo">
            <i class="fab fa-weibo fa-fw"></i>
        </a>
    {{- end -}}
--- a/layouts/posts/single.html
+++ b/layouts/posts/single.html
@ -9,8 +9,8 @@
        <div class="meta">
            <div class="meta-line">
                {{- $author := .Params.author | default .Site.Author.name -}}
-                {{- $author_link := .Params.author_link | default .Site.Author.link | default .Site.BaseURL -}}
-                <a class="author" href="{{ $author_link }}" rel="author" target="_blank">
+                {{- $authorLink := .Params.authorLink | default .Site.Author.link | default .Site.BaseURL -}}
+                <a class="author" href="{{ $authorLink }}" rel="author" target="_blank">
                    <i class="fas fa-user-circle fa-fw"></i>{{ $author }}
                </a>&nbsp;
                {{- with .Params.categories -}}
@ -39,7 +39,7 @@
        </div>

        {{- /* Featured image */ -}}
-        {{- with .Params.featured_image -}}
+        {{- with .Params.featuredImage -}}
            <div class="featured-image">
                {{- partial "hook/image" . -}}
            </div>
@ -49,8 +49,8 @@
        {{- if or .Params.toc (and .Site.Params.toc (ne .Params.toc false)) -}}
            <div class="post-toc" id="post-toc">
                <h2 class="post-toc-title">{{ T "toc" }}</h2>
-                {{- $globalAutoCollapseToc := .Site.Params.auto_collapse_toc | default true }}
-                <div class="post-toc-content{{ if not (and $globalAutoCollapseToc (ne .Params.auto_collapse_toc false)) }} always-active{{ end }}">
+                {{- $globalAutoCollapseToc := .Site.Params.autoCollapseToc | default true }}
+                <div class="post-toc-content{{ if not (and $globalAutoCollapseToc (ne .Params.autoCollapseToc false)) }} always-active{{ end }}">
                    {{- .TableOfContents -}}
                </div>
            </div>