Hexo 隐藏文章插件: hexo-hide-posts 使用指南

Hexo 隐藏文章插件: hexo-hide-posts 使用指南

---

1. 项目目录结构及介绍

hexo-hide-posts 是一个专为 Hexo 博客框架设计的插件，它允许用户将特定的文章设置为隐藏状态，仅通过直接链接可达。以下是该插件的基本目录结构及其简要说明：

hexo-hide-posts/
├── lib/                 # 存放核心逻辑代码的文件夹
│   └── index.js         # 主要执行文件，实现文章隐藏的功能
├── .eslintignore        # ESLint 忽略文件列表
├── .eslintrc            # ESLint 配置文件
├── .gitignore           # Git 忽略文件列表
├── LICENSE              # 许可证文件，采用 MIT 协议
├── README.md             # 英文版的插件说明文档
├── README_ZH.md         # 中文版的插件说明文档，为本教程所参照
├── package.json         # 包含依赖信息和脚本命令的文件
├── pnpm-lock.yaml       # 包管理器锁定文件，记录具体版本细节
└── ...

2. 项目的启动文件介绍

虽然直接“启动”这个插件的概念不适用于常规操作（插件是在Hexo构建或生成博客时自动激活的），但其主要功能性代码位于 lib/index.js 文件中。这个文件是插件的核心，负责读取配置并修改Hexo的处理流程，确保标记为隐藏的文章不会出现在默认的列表中，除非通过特定的生成器允许。

安装并配置好插件后，Hexo在运行 hexo generate 或 hexo server 等命令时会加载并应用该插件的逻辑。

3. 项目的配置文件介绍

要在你的 Hexo 博客中启用并配置 hexo-hide-posts 插件，你需要编辑博客根目录下的 _config.yml 文件，并添加或修改以下部分：

# hexo-hide-posts 配置项
hide_posts:
  # 是否启用插件
  enable: true
  # 前端元数据的关键字，用于标识哪些文章应被隐藏
  filter: hidden
  # 是否添加 "noindex" 标签以阻止搜索引擎索引隐藏文章
  noindex: true
  # 指定哪些生成器可以访问隐藏的文章（空列表表示所有都不允许，需手动指定才能访问）
  allowlist_generators: []
  # 指定哪些生成器不能访问隐藏的文章（优先级高于允许列表，设置'*'则屏蔽所有默认生成器对隐藏文章的访问）
  blocklist_generators: ['*']

在这段配置中，filter 字段用于设定在文章的前端 matter 中使用的标签名称，以标记文章是否应被隐藏；noindex 设置控制隐藏文章是否对搜索引擎友好；而 allowlist_generators 和 blocklist_generators 允许精细控制哪些自动生成的页面可以包括这些隐藏的文章。

通过以上步骤，你可以灵活地控制博客中的文章可见性，增强内容管理的灵活性。