模塊

本節內容

• 模塊概覽
  本文介紹瞭如何安裝、卸載、升級、清理和整頓模塊。
• 核心模塊
  • 核心模塊概覽
    HB 框架的核心模塊。
  • 核心模塊配置
    HB 核心模塊的站點參數和頁面參數。
  • 核心模塊的 HugoPress 定義
    HB 核心模塊的自定義 HugoPress 屬性和鉤子列表。
  • 模塊原理
    本文介紹了該模塊的目錄結構、工作原理和一些開發約定。
• 頁頭模塊
  通用的頁頭模塊。
  • 頁頭概覽
    頁頭模塊是一個通用的頂部應用欄，其帶有一些實用的子模塊，比如搜索表單、社交鏈接、淺色/深色切換以及語言切換等。
  • 頁頭菜單

    本文將介紹如何配置頁頭菜單。

  • 頁頭搜索模塊

    頁頭搜索模塊顯示了一個搜索表單和按鈕，以打開搜索面板。

  • HB 頁頭 Git 倉庫模塊
    此模塊於頁頭顯示關於 Git 倉庫的相關信息，比如最新版本、星星數量、forks 數量。
  • HB 頁頭 Git 組織模塊
    此模塊於頁頭顯示關於 Git 組織的相關信息，比如頭像、關注人數、倉庫數量和星星總數。
  • 頁頭新聞模塊
    The HB 頁頭新聞模塊作為公告欄模塊的替代品，其自動顯示最近的新聞。
  • 頁頭谷歌自定義搜索引擎模塊
    於頁頭添加谷歌自定義搜索引擎。
  • 頁頭橫幅
    於頁頭展現一幅圖片或一段視頻。
  • 頁頭主題
    本文展示可用的頁頭主題。
  • 頁頭 DocSearch 模塊

    DocSearch 是一個線上搜索引擎，其爲開源文檔站點提供免費服務。

  • 頁頭主題切換模塊

    該模塊允許用戶從淺色、深色和自動（跟隨系統）三個主題之間進行切換。

  • 頁頭社交鏈接模塊

    該模塊於頁頭生成和顯示社交鏈接。

  • 頁頭語言選項模塊

    用戶可以通過頁頭的語言選項模塊切換語言，這對多語言站點來說十分實用。

• 頁尾模塊
  通用的頁尾模塊。
  • 頁尾概覽

    該模塊爲通用的頁尾，其帶有菜單和一些實用的子模塊，如社交鏈接。

  • 頁尾菜單

    本文將描述如何配置頁尾菜單。

  • 頁尾社交鏈接

    該模塊於頁尾生成和顯示社交鏈接。

  • 頁尾備案模塊

    該模塊用於顯示備案相關鏈接。

  • 頁尾鉤子

    本文列出頁尾模塊的自定義鉤子。

• 基礎模塊

  基本模塊爲其他模塊提供了一些基本的佈局和模板，如落地頁、404 頁面不存在、頁頭模塊和頁尾模塊。

• 博客模塊
  通用的博客模塊。
  • 博客概覽

    博客模塊為博客站點提供了基本的佈局和模板。

  • 博文作者

    博客模塊默認支持多作者。

  • 博客修訂模塊
    於博客文章下方顯示修訂信息。
  • 博客社交分享按鈕模塊
    於博客文章下方顯示社交分享按鈕。
  • 博客側邊欄
    • 博客側邊欄概覽

      博客模塊支持一個可選的側邊欄佈局。

    • HB 博客側邊欄簡介模塊
      通過標題、描述、位置、社交連接等較少你自己或你的公司。
    • 博客側邊欄分類模塊

      該模塊於博客側邊欄顯示分類列表。

    • 博客側邊欄文章模塊

      本模塊於博客側邊欄顯示最近和精選的文章列表。

  • 相關文章

    該模塊於博文內容下方顯示相關文章。

  • 特色圖片

    若存在特色圖片時，其將被顯示在博文上方。

  • 博客內容面板

    該模塊將內容面板集成到博客。

  • 博客文章作者模塊
    此模塊於內容上方或下方顯示文章作者信息。
  • 博客文章導航

    該模塊將於內容下方生成菜單，用於導航到相同欄目的上一篇和下一篇文章。

  • 博客目錄滾動監聽模塊

    自動更新內容目錄導航，以指示視口中當前活動的標題。

  • 博客粘性模塊
    默認情況下，側邊欄和目錄會一直粘性到頁腳，有了這個模塊，它們可以一直保持粘性。
  • 博客鉤子

    本文列出博客模塊的自定義鉤子。

  • 博客麪包屑導航

    該模塊爲博客佈局提供麪包屑導航支持。

  • 評論系統
    • 博客 Staticman 評論模塊

      該模塊將 Staticman 評論模塊集成於博客佈局。

    • Disqus

      該模塊爲博客模塊提供 Disqus 評論支持。

    • Emote

      該模塊為博客添加 Emote 評論模塊支持。

    • 博客 Giscus 評論引擎

      該模塊爲博客模塊提供 Giscus 評論引擎支持，其基於 GitHub 討論實現。

    • 博客 Twikoo 模塊

      該模塊爲 Twikoo 提供支持，其爲一個簡單、安全和免費的評論系統。

    • 博客 Utterances 評論引擎

      該模塊爲博客提供 Utterances 評論引擎的支持，其基於 GitHub issues.

  • 標題鏈接

    當鼠標懸停於標題上時，該模塊將顯示其錨點鏈接。

• 文檔模塊
  通用的文檔模塊。
  • 文檔概覽

    文檔模塊爲文檔站點提供了基本的佈局和模板，其對於編寫項目文檔、數字花園、用戶指南、教程等十分實用。

  • 文檔社交分享按鈕模塊
    於文檔正文下方顯示社交分享按鈕。
  • 文檔修訂模塊
    於文檔下方顯示修訂信息。
  • 文檔內容面板

    該模塊將內容面板集成到博客。

  • 文檔目錄滾動監聽模塊

    自動更新內容目錄導航，以指示視口中當前活動的標題。

  • 文檔特色圖片

    若存在特色圖片時，其將被顯示在文檔上方。

  • 文檔粘性模塊
    默認情況下，側邊欄和目錄會一直粘性到頁腳，有了這個模塊，它們可以一直保持粘性。
  • 文檔鉤子

    本文列出文檔模塊的自定義鉤子。

  • 文檔導航

    該模塊將於內容下方生成菜單，用於導航到相同欄目的上一篇和下一篇文檔。

  • 文檔標題鏈接

    當鼠標懸停於標題上時，該模塊將顯示其錨點鏈接。

  • 文檔麪包屑導航

    該模塊爲文檔佈局提供麪包屑導航支持。

  • 評論系統
    • 文檔 Staticman 評論模塊

      該模塊將 Staticman 評論模塊集成於文檔佈局。

    • Emote

      該模塊為文檔添加 Emote 評論模塊支持。

    • 文檔 Disqus 評論引擎

      該模塊爲文檔模塊提供 Disqus 評論支持。

    • 文檔 Giscus 評論引擎

      該模塊爲博客模塊提供 Giscus 評論引擎支持，其基於 GitHub 討論實現。

    • 文檔 Twikoo 模塊

      該模塊爲 Twikoo 提供支持，其爲一個簡單、安全和免費的評論系統。

    • 文檔 Utterances 評論引擎

      該模塊爲文檔模塊提供 Utterances 評論引擎的支持，其基於 GitHub issues.

• 圖庫模塊
  • 圖庫概覽

    圖庫模塊爲圖片提供了一個簡單的佈局。

  • 圖庫鉤子

    本文列出圖庫模塊的自定義鉤子。

  • 圖庫麪包屑導航

    該模塊爲圖庫佈局提供麪包屑導航支持。

• 元模塊

  元模塊並不提供任何功能，其只是模塊的集合，以簡化模塊的安裝和卸載。

• 內容模塊
  • Inline Frame 模塊

    該模塊提供了一個通用的 inline frame 短代碼。

  • Blockquote 警告模塊
    用於通過 Blockquote 生成警告，與短代碼相比，其更加簡單易用。
  • Bootstrap 模塊

    該模塊將 Bootstrap 模塊移植到 HB，以添加缺少的組件。

  • Mermaid 模塊

    Mermaid 是一個基於 JavaScript 的圖表工具，使用 Markdown 啓發的文本定義和一個渲染器來創建和修改複雜的圖表。

• 用戶體驗
  • No Script 模塊

    當用戶瀏覽器不支持 JavaScript 時，該模塊將顯示一條警告信息。

  • 返回頂部模塊

    又稱回到頂部，一個用於返回頂部的按鈕。

  • 首選語言模塊

    當 defaultContentLanguageInSubdir 被啓用時，Hugo 將把主頁重定向到默認語言網站，例如：/ -> /en/。這個模塊將嘗試根據用戶的首選語言來重定向網站。

• 增強模塊
  • 聯繫表單模塊

    該模塊內置了一個佈局和短代碼，以生成聯繫表單，其兼容大部分表單服務後端。

  • 公告欄

    公告欄模塊突出一些重要的事情，比如新聞和項目的新版本。

  • Bigger Picture 模塊

    當點擊一張不可鏈接的圖片時，將彈出一個圖片查看器。

  • HB PWA 安裝器
    HB PWA 安裝器模塊於頁面底部顯示一個按鈕，用於添加站點到首頁。
  • PWA 模塊

    該模塊將 Hugo PWA 模塊 集成到 HB，以自定義離線頁面，以及調整一些參數。

• 觀感
  • 縮寫的 Bootstrap 提示框
    將縮寫的內置提示框替換為 Bootstrap 提示框。
  • 谷歌字體模塊
    該模塊將谷歌字體整合於 HB 框架，其允許制定多個字體及其軸範圍。
  • 代碼塊面板

    代碼塊面板提供了展開代碼、複製代碼、代碼換行和切換代碼行號等功能。

  • 背景圖片模塊

    照字面意思，該模塊爲站點設置背景圖片。

  • 進度條模塊

    當在當前標籤頁和窗口打開一個新頁面時，將顯示進度條。

  • 滾動條模塊

    該模塊修改瀏覽器默認的滾動條樣式。

  • 語法高亮模塊

    HB 提供了數十個語法高亮顯示模塊，本文將列出所有支持的樣式。

• 組件
  • 目錄滾動監聽模塊
    自動更新內容目錄導航，以指示視口中當前活動的標題。
  • Bootstrap 提示框模塊
    此模塊為 HB 框架添加 Bootstrap 提示框支持。
  • HB 標題符號模塊
    當用戶懸停時，該模塊於標題旁邊顯示一個錨點鏈接。
  • HB 修訂模塊
    描述頁面的額外信息，如創建日期、修改日期等。
  • HB 社交分享按鈕模塊
    該模塊方便用戶分享頁面到流行的社交媒體。
  • HB 麵包屑導航組件
    HB 麵包屑導航組件可用於指示當前頁面的位置。
  • Staticman 評論模塊

    Staticman 評論模塊爲其他模塊提供了一個靈活的模板，以生成評論表單和顯示嵌套的評論。

  • 內容面板模塊

    該模塊於單頁頁面顯示一個內容面板，其包含了譯文、評論和倉庫相關按鈕。

  • 分頁

    該模塊附帶了一個通用的分頁模板，其允許通過參數進行配置，如對齊方式、尺寸和兄弟節點的數量。

  • 幻燈片模塊

    該模塊實現了一個簡單的幻燈片，博客相關文章 正是基於此模塊開發的。

  • 社交鏈接

    該社交模塊用於生成社交鏈接。

  • 搜索模塊

    該模塊將 Hugo 搜索模塊 集成於 HB 中，其爲一個強大的、靈活的和響應式的客戶端模糊搜索模塊。

• 短代碼
  HB 框架額外的短代碼。
  • HB 劇透標籤短代碼
    劇透標籤可以讓你寫下一些用戶可能不想看到的文字，並將其隱藏起來，直到讀者選擇查看。