佈景主題參數 (單篇文章)
此處列出佈景主題提供的 Front Matter 參數,控制層面為頁面 UI,以及封面圖片等。
目次
關於 Front Matter
準備 Hugo 的各種頁面和文章時,你可以在檔案裡的 Front Matter 區塊提供後設資料、自訂頁面選項。此主題提供的 Front Matter 參數都巢狀歸在 neso
命名空間下,例如,以下是寫在 Markdown 檔案開頭的 YAML 格式 Front Matter:
---
title : "貓貓快樂的一天"
date : 2025-10-06T14:53:12+08:00
description : "這是貓貓自己寫的日記,絕無鏟屎官干預。"
# 其他略...
# 以上是 Hugo 本身提供的 Front Matter 欄位 (僅舉一部分為例)
params:
# 以下是本佈景主題提供的 Front Matter 參數欄位 (僅舉一部分為例)
neso:
# 都歸在 `neso` 命名空間下
author : "朵貓貓"
show_toc : false
cover:
# 封面圖選項會再巢狀一層
image : "selfie.jpg"
caption : "貓貓自拍照"
# 其他略...
---
<!-- 以下是主要的文章/頁面內容 -->
ddddddddddd,,,,,,,,,,,,,,,,,,,,,cfvsssssssszzzz
提示
即使完全不使用佈景主題提供的
neso
參數,Hugo 也能順利建置文章,有需要再使用即可。
補充
作者習慣在全站設定用 TOML 格式、在 Front Matter 用 YAML 格式,所以本篇說明會以 YAML 示範。
一般設定
直接寫在 neso
下 (注意縮排):
params:
neso:
show_toc: true # 設定的鍵、值
toc_expanded: true # 設定的鍵、值
# 下略...
頁首文章資訊
文章頁首區塊用來顯示發表日期、作者、字數統計⋯⋯等等的後設資料。
鍵名 | 類型 | 說明 |
---|---|---|
author | String String[] | 作者名稱;只有一人的話可直接給字串,例如 "李清照" ,需要顯示多人的話可用字串陣列,例如 ["蘇洵", "蘇軾", "蘇轍"] |
disable_author | Boolean | 在此頁面關閉作者資訊 (注意:此選項僅可用來關閉功能,若全站設定已關,這裡無法覆寫為開) |
disable_reading_time | Boolean | 在此頁面關閉閱讀時間估計 (注意:此選項僅可用來關閉功能,若全站設定已關,這裡無法覆寫為開) |
disable_word_count | Boolean | 在此頁面關閉字數統計 (注意:此選項僅可用來關閉功能,若全站設定已關,這裡無法覆寫為開) |
canonical_url | String | 如果你的文章原本是發表於他處,可以在此欄位填寫原文 URL |
canonical_link_text | String | 顯示 canonical_url 連結時,要在開頭加上的預設字串;例如 原文發表於 |
hide_metadata | Boolean | 隱藏整個頁首區塊 |
頁尾功能
文章頁尾區塊用來顯示文章標籤、分享按鈕、繼續閱讀上/下篇等功能。
鍵名 | 類型 | 說明 |
---|---|---|
show_prev_next | Boolean | 顯示「上/下一篇」文章,供訪客延伸閱讀 |
disable_share | Boolean | 在此頁面關閉分享按鈕 (注意:此選項僅可用來關閉功能,若全站設定已關,這裡無法覆寫為開) |
disable_content_footer | Boolean | 隱藏整個頁尾區塊 (注意:此選項僅可用來隱藏區塊,若已在全站設定設為隱藏,這裡無法覆寫為顯示) |
其他
鍵名 | 類型 | 說明 |
---|---|---|
disable_breadcrumbs | Boolean | 在此頁面關閉麵包屑導覽列 (注意:此選項僅可用來關閉功能,若全站設定已關,這裡無法覆寫為開) |
show_toc | Boolean | 顯示內文目次 |
toc_expanded | Boolean | 預先展開內文目次 |
disable_comments | Boolean | 在此頁面關閉評論/留言區塊 (注意:此選項僅可用來關閉功能,若全站設定已關,這裡無法覆寫為開) |
exclude_from_search | Boolean | 在站內搜尋結果中排除此頁面 |
block_indexing | Boolean | 將此頁面的 <meta name="robots"> 設為 noindex 、nofollow |
封面圖片
將設定縮排寫在 neso
內的 cover
下:
params:
neso:
show_toc: true
# 其他設定略...
cover:
image : "meow.png"
caption : "可愛喵"
alt_text : "一隻黑貓正在喵喵叫"
hidden_in_list : false
hidden_in_single : false
鍵名 | 類型 | 說明 |
---|---|---|
image | String | 圖檔 URL;可寫相對於文章檔案的相對路徑、或是絕對路徑 |
caption | String | 顯示在封面圖片下方的文字敘述 |
alt_text | String | 封面圖片的替代文字 |
hidden_in_list | Boolean | 在文章列表隱藏封面圖片 |
hidden_in_single | Boolean | 在文章頁面本身隱藏封面圖片 |