Hexo-Front-matter说明

Hexo 默认 Front-matter 字段详解

以下是 Hexo 默认的 Front-matter 字段及其默认行为的详细列表：

• layout: 布局

  • 含义: 指定文章使用的布局模板。Hexo 默认会使用 _theme/layout 目录下的模板文件进行渲染。
  • 默认值: config.default_layout，通常在主题的配置文件 _config.yml 或 _config.[theme_name].yml 中定义，默认可能是 post。
  • 说明: 你可以根据你的需求，创建自定义布局，并在 Front-matter 中指定，例如 layout: page 用于创建独立页面。

• title: 标题

  • 含义: 文章的标题。
  • 默认值: 文章的文件名（不包括扩展名）。 例如，如果文件名为 my-first-post.md，则标题默认为 my-first-post。
  • 说明: 强烈建议在 Front-matter 中明确指定文章标题，可以提高文章的可读性以及 SEO 优化。

• date: 建立日期

  • 含义: 文章的创建日期。
  • 默认值: 文件建立日期。
  • 说明: 文章的日期格式会影响文章在列表中排序，通常使用 YYYY-MM-DD HH:mm:ss 格式。强烈建议在 Front-matter 中明确指定文章创建日期。

• updated: 更新日期

  • 含义: 文章的最后更新日期。
  • 默认值: 文件更新日期。
  • 说明: 如果文章进行了更新，建议修改这个日期，让读者知道文章内容已更新。有些主题会显示文章的更新日期。

• comments: 开启文章的评论功能

  • 含义: 是否开启文章的评论功能。
  • 默认值: true (开启)。
  • 说明: 可以设置为 true 开启评论功能，或 false 关闭评论功能。 如果你的博客集成了评论系统，则会根据此值来决定是否显示评论区。

• tags: 标签

  • 含义: 文章的标签，用于对文章进行分类。
  • 默认值: 空。
  • 说明: 标签通常用于博客的侧边栏或者标签页面显示，便于读者浏览同一标签的文章。 不适用于分页 指的是标签不会参与到分页逻辑中。

• categories: 分类

  • 含义: 文章的分类，用于对文章进行分类。
  • 默认值: 空。
  • 说明: 分类通常用于博客的侧边栏或者分类页面显示，便于读者浏览同一分类的文章。 不适用于分页 指的是分类不会参与到分页逻辑中。

• permalink: 覆盖文章的永久链接

  • 含义: 自定义文章的永久链接，覆盖 Hexo 根据日期和标题生成的默认链接。
  • 默认值: null (使用默认链接生成规则)。
  • 说明: 永久链接应该以 / 或 .html 结尾。 可以使用这个字段生成更具语义化的 URL。

• excerpt: 纯文本的页面摘要

  • 含义: 文章的摘要，用于列表页面、预览等显示文章内容的概述。
  • 默认值: 空。
  • 说明: 如果没有设置，Hexo 会尝试从文章内容中截取一段文本作为摘要， 使用 <!--more--> 分隔符可以明确指定摘要部分。 可以配合相关插件实现更丰富的摘要格式。

• disableNunjucks: 启用时禁用 Nunjucks 标签

  • 含义: 控制是否禁用文章中 Nunjucks 模板引擎的渲染功能。
  • 默认值: false (不禁用，默认启用)
  • 说明: 如果文章内容中使用了类似{{ }} 和 {% %} 的内容，并且与 Nunjucks 语法冲突，则可以将此字段设置为 true, 禁用 Nunjucks 标签解析，避免解析错误。

• lang: 设置语言以覆盖自动检测

  • 含义: 设置当前文章使用的语言，覆盖 Hexo 自动检测到的语言。
  • 默认值: 继承自 _config.yml，通常会根据 language 设置项确定。
  • 说明: 如果文章的语言与 Hexo 的默认语言不一致，可以使用这个字段进行指定。

• published: 文章是否发布

  • 含义: 指示文章是否处于发布状态。
  • 默认值: 对于 _posts 下的文章为 true，对于 _drafts 下的文章为 false。
  • 说明: 可以利用这个字段来控制文章是否显示在网站上，或者在编写草稿时，将其设置为 false。

• hide: 隐藏文章

  • 含义: 控制文章是否在首页、归档页和分类页等列表中显示。
  • 默认值: false (不隐藏，默认显示)。
  • 说明: 设置为 true 可以隐藏文章，使其不在列表页中展示，但仍可通过 URL 直接访问。当前主题支持

• archive: 归档文章

  • 含义: 控制文章是否在首页隐藏，但仍显示在归档页和分类页等列表中。
  • 默认值: false (不在首页隐藏，默认显示)。
  • 说明: 设置为 true 可以隐藏文章在首页的显示，但仍会在归档页、分类页和标签页中显示。

• sticky: 文章置顶

  • 含义: 控制文章在首页列表中的显示顺序，将文章置顶显示。
  • 默认值: null (不置顶，按时间排序)。
  • 说明: 设置一个数值，可以将文章置顶。数值越大，文章越靠前。需要安装 hexo-generator-index >= 2.0.0 版本才能生效。

• index_img: 文章在首页的封面图

  • 含义: 指定文章在首页列表等位置显示的封面图。
  • 默认值: 空 (不显示封面图)。
  • 说明: 提供图片链接或路径，用于在首页文章列表中显示缩略图。

• banner_img: 文章页顶部大图

  • 含义: 指定文章页面顶部显示的横幅大图。
  • 默认值: 使用主题配置中 post.banner_img 的设置。
  • 说明: 提供图片链接或路径，覆盖主题配置的默认设置，为当前文章设置自定义顶部大图。

暂时了解到的就这些，如果后续我使用了新的配置，我仍会更新到此