模块

本节内容

• 模块概览
  本文介绍了如何安装、卸载、升级、清理和整顿模块。
• 核心模块
  • 核心模块概览
    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.

  • 文档标题链接

    当鼠标悬停于标题上时，该模块将显示其锚点链接。

  • 文档导航

    该模块将于内容下方生成菜单，用于导航到相同栏目的上一篇和下一篇文档。

  • 文档钩子

    本文列出文档模块的自定义钩子。

  • 文档面包屑导航

    该模块为文档布局提供面包屑导航支持。

  • 文档目录滚动监听模块

    自动更新内容目录导航，以指示视口中当前活动的标题。

  • 文档内容面板

    该模块将内容面板集成到博客。

  • 文档特色图片

    若存在特色图片时，其将被显示在文档上方。

  • 文档粘性模块
    默认情况下，侧边栏和目录会一直粘性到页脚，有了这个模块，它们可以一直保持粘性。
• 图库模块
  • 图库概览

    图库模块为图片提供了一个简单的布局。

  • 图库钩子

    本文列出图库模块的自定义钩子。

  • 图库面包屑导航

    该模块为图库布局提供面包屑导航支持。

• 元模块

  元模块并不提供任何功能，其只是模块的集合，以简化模块的安装和卸载。

• 观感
  • 缩写的 Bootstrap 提示框
    将缩写的内置提示框替换为 Bootstrap 提示框。
  • 谷歌字体模块
    该模块将谷歌字体整合于 HB 框架，其允许制定多个字体及其轴范围。
  • 背景图片模块

    照字面意思，该模块为站点设置背景图片。

  • 代码块面板

    代码块面板提供了展开代码、复制代码、代码换行和切换代码行号等功能。

  • 滚动条模块

    该模块修改浏览器默认的滚动条样式。

  • 进度条模块

    当在当前标签页和窗口打开一个新页面时，将显示进度条。

  • 语法高亮模块

    HB 提供了数十个语法高亮显示模块，本文将列出所有支持的样式。

• 内容模块
  • 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，以自定义离线页面，以及调整一些参数。

• 短代码
  HB 框架额外的短代码。
  • HB 剧透标签短代码
    剧透标签可以让你写下一些用户可能不想看到的文字，并将其隐藏起来，直到读者选择查看。
• 组件
  • Bootstrap 提示框模块
    此模块为 HB 框架添加 Bootstrap 提示框支持。
  • HB 标题符号模块
    当用户悬停时，该模块于标题旁边显示一个锚点链接。
  • HB 修订模块
    描述页面的额外信息，如创建日期、修改日期等。
  • HB 社交分享按钮模块
    该模块方便用户分享页面到流行的社交媒体。
  • HB 面包屑导航组件
    HB 面包屑导航组件可用于指示当前页面的位置。
  • Staticman 评论模块

    Staticman 评论模块为其他模块提供了一个灵活的模板，以生成评论表单和显示嵌套的评论。

  • 分页

    该模块附带了一个通用的分页模板，其允许通过参数进行配置，如对齐方式、尺寸和兄弟节点的数量。

  • 幻灯片模块

    该模块实现了一个简单的幻灯片，博客相关文章 正是基于此模块开发的。

  • 内容面板模块

    该模块于单页页面显示一个内容面板，其包含了译文、评论和仓库相关按钮。

  • 社交链接

    该社交模块用于生成社交链接。

  • 搜索模块

    该模块将 Hugo 搜索模块 集成于 HB 中，其为一个强大的、灵活的和响应式的客户端模糊搜索模块。