Tools 工具箱 — 功能详细介绍

作者: Lywq

Tools 工具箱是面向 Halo 博客平台的综合增强插件,覆盖内容保护、微信公众号对接、SEO 优化、自动化发布等核心场景。本文档面向用户,详细介绍每个功能模块。


目录

  1. 限制阅读
  2. 微信公众号同步
  3. 微信公众号对接
  4. 文章定时发布
  5. 百度 SEO 推送
  6. 下载信息块
  7. 自定义弹窗
  8. 随机图与图片代理
  9. 付费订单管理
  10. 环境与配置

1. 限制阅读

限制阅读功能允许你对文章或页面的内容访问进行控制,适用于付费内容、会员专属、互动激励等场景。

Tools工具箱插件-演示限制阅读模式.png

1.1 五种访问模式

模式说明适用场景
验证码访问读者需输入验证码才能查看内容关注公众号获取验证码,引流涨粉
密码访问读者需输入密码特定人群分享密码,如社群、课程
付费访问读者支付后解锁内容付费专栏、教程、资源下载
登录访问仅登录用户可查看,支持角色限制会员专属内容
评论访问读者需提交并通过审核的评论互动激励,提升评论量

1.2 限制区域

  • 全部内容:整篇文章完全隐藏,读者通过验证后才可查看全文
  • 指定内容:文章中部分内容可见,仅标记区域需要验证。通过在编辑器中插入「限制阅读分割」和「限制阅读内容」节点来划分

Tools工具箱插件-限制阅读内容设置.png

1.3 编辑器扩展节点

插件在 Halo 编辑器中注册了两个自定义节点:

  • 限制阅读分割restrict-read-html):将文章分为可见区和隐藏区,每篇文章仅可插入一个
  • 限制阅读内容restrict-read-block):标记需要限制的内容块,可插入多个

1.4 验证缓存

读者通过验证后,系统会自动记录缓存,同一会话内再次访问无需重复验证,提升阅读体验。

1.5 免校验角色

在插件设置中配置 noCheckRoles,指定角色(如管理员)可跳过所有限制阅读检查。


2. 微信公众号同步

一键将 Halo 已发布文章同步到微信公众号草稿箱,告别手动复制粘贴和重复排版。

Tools工具箱插件-演示微信公众号同步入口.png

2.1 同步流程

  1. 在文章列表中点击「同步至微信公众号」
  2. 弹窗自动加载预览:标题、摘要、封面、渲染后的公众号内容
  3. 可在弹窗内编辑标题、作者、摘要、封面图、原文链接
  4. 内置 Markdown 编辑器,支持实时编辑和预览
  5. 点击「同步到草稿箱」完成同步
  6. 到「微信公众号同步」页面管理发布状态

Tools工具箱插件-同步至微信公众号1.png

2.2 内容渲染

  • Markdown / HTML 自动转换为微信兼容格式
  • 支持表格、任务列表、删除线等扩展语法
  • 文章中的所有图片自动下载并上传到微信服务器
  • 下载信息块和限制阅读节点自动降级为「请回原文查看」提示卡片

Tools工具箱插件-同步至微信公众号2.png

2.3 同步前检查

系统自动校验以下条件,不符合时会给出明确提示:

  • 文章已发布且存在发布快照
  • 摘要不为空且长度不超过 54 字
  • 封面图已填写且尺寸/格式符合微信要求
  • 渲染后内容超过 20000 字时在前端提示风险

2.4 同步记录管理

进入 控制台 -> 微信公众号同步 页面,可进行:

  • 查看所有同步记录及状态(待同步 / 同步中 / 草稿 / 同步失败 / 发布中 / 已发布 / 发布失败 / 已删除 / 远程已删除)
  • 按状态筛选、按关键词搜索
  • 发布草稿、刷新发布状态、删除草稿
  • 发送预览到指定微信用户

Tools工具箱插件-同步至微信公众号3.png

2.5 微信编辑器

弹窗内置 Markdown 编辑器,可在同步前直接编辑要发送到微信的内容,支持:

  • 实时预览渲染效果
  • 切换编辑/预览模式
  • 独立于原文的自定义编辑

3. 微信公众号对接

将微信公众号与 Halo 博客深度打通,实现公众号内的丰富交互。

3.1 关注自动回复

用户关注公众号时自动回复,支持:

  • 文本消息:自定义欢迎语
  • 图文消息:引导用户阅读精选文章

Tools工具箱插件-演示关键字回复.png

3.2 关键词回复

配置关键词与回复的映射关系,支持:

  • 多关键词配置
  • 每个关键词可选择文本或图文回复
  • 精确匹配模式

Tools工具箱插件-演示关键字回复.png

3.3 文章搜索

用户在公众号内发送特定关键词前缀(如「搜索 + 关键词」),即可搜索博客文章:

  • 返回文本链接或图文卡片
  • 支持自定义搜索关键词前缀
  • 可选择使用主题自带搜索页或插件自定义搜索页

Tools工具箱插件-演示搜索文章.png

3.4 友链提交

用户在公众号内按格式发送消息即可提交友链:

提交友链
友链名称:xxx;
友链地址:xxx;
友链图标:xxx;
友链描述:xxx;

Tools工具箱插件-演示提交友链.png

3.5 瞬间提交

支持在公众号内提交瞬间(微动态),含图片和视频:

提交瞬间
内容:xxx;
标签:xxx;

提交后可发送图片/视频作为配图,最终确认发布。

Tools工具箱插件-演示提交瞬间.png

3.6 验证码获取

用户发送指定关键词,即可收到限制阅读所需的验证码,实现「关注公众号 -> 获取验证码 -> 解锁内容」的引流闭环。

3.7 其他交互

  • 获取 OpenID:用户发送「获取openid」获取自己的微信 OpenID
  • 评论通知:文章有新评论时,通过微信模板消息或订阅消息通知博主

限制阅读演示-验证码访问.png


4. 文章定时发布

设定文章在未来某个时间自动发布,无需手动操作。

Tools工具箱插件-演示文章定时发布.png

使用方式

  1. 在文章编辑页的注解设置中开启「定时发布」
  2. 设置发布时间
  3. 保存文章(此时文章为待发布状态)
  4. 到达设定时间后,系统自动将文章发布

配置项

  • 定时发布总开关
  • Cron 表达式(控制检查频率)

5. 百度 SEO 推送

自动将已发布文章的 URL 推送到百度站长平台,加速搜索引擎收录。

配置项

  • 推送开关
  • 百度站长平台 Token
  • 推送 Cron 表达式(控制推送频率)

工作方式

系统按设定的频率自动扫描已发布文章,将新发布的文章 URL 批量推送到百度链接提交 API。


6. 下载信息块

在文章中插入标准化的下载卡片,提供清晰的下载信息展示。

Tools工具箱插件-下载信息演示.png

6.1 支持的下载源

内置十余种常见下载源,每个都有对应图标:

百度网盘、阿里云盘、蓝奏云、123 云盘、夸克网盘、微云、GitHub、Gitee、OneDrive、Google Drive 等

6.2 卡片字段

  • 下载来源(自动匹配图标)
  • 文件名
  • 下载链接
  • 提取码(可选)

6.3 编辑器使用

在 Halo 编辑器中插入「下载信息」节点,填写相应字段即可。前台自动渲染为样式统一的下载卡片,适配亮色/暗色主题。

Tools工具箱插件-下载设置教程1.png


7. 自定义弹窗

灵活配置前台弹窗,用于公告、推广、通知、Cookie 同意等场景。

Tools工具箱插件-演示自定义弹窗.png

7.1 内置模板

模板适用场景
默认样式通用通知
Cookie 同意Cookie 合规提示
铃铛通知消息提醒
模态框重要公告
卡片样式活动推广

7.2 配置能力

  • 挂载路径:支持多规则、通配符、查询参数匹配,精确控制弹窗出现的页面
  • 位置:居中、四角可选
  • 遮罩层:可选是否显示半透明背景
  • 按钮动作:支持取消、关闭、打开链接、打开并关闭等操作
  • 自动关闭:可设置自动关闭时间
  • 显示频率:按小时控制间隔,-1 表示仅显示一次
  • 自定义模板:内置模板不满足需求时,可编写自定义 HTML/CSS/JS

8. 随机图与图片代理

8.1 随机图片 API

提供随机图片接口,支持按类型获取:

GET /apis/tools.muyin.site/v1alpha1/image/random?type=类型标识
  • 可配置多个图片源 API
  • 支持按类型分类(如风景、动漫、人物等)
  • 适用于文章配图、头像占位、随机封面等场景

8.2 图片代理 API

代理外部图片资源,解决防盗链问题:

GET /apis/tools.muyin.site/v1alpha1/image/proxy?url=图片地址
  • 自动检测图片内容类型
  • 限制重定向次数、响应大小、超时时间
  • 内置安全防护:拦截内网地址和本机地址

9. 付费订单管理

配合 PluginPayment 插件,实现完整的付费内容支付闭环。

Tools工具箱插件-演示支付订单管理.png

9.1 支付能力

  • 支持支付宝、微信支付两种渠道
  • 支持登录支付和免登录支付两种模式
  • 按文章/页面注解中设置的金额发起支付
  • 支付成功后自动解锁内容

9.2 订单管理

进入 控制台 -> 限制阅读记录,可进行:

  • 查看所有支付订单及状态(未支付 / 支付中 / 成功 / 失败)
  • 按内容类型和状态筛选
  • 批量删除未完成的订单(成功订单不可删除)

9.3 自动化

  • 订单状态后台自动同步(可配置同步频率)
  • 前端支付后自动轮询状态(可配置轮询间隔和次数)
  • 支付成功通知(每笔订单仅通知一次)

10. 环境与配置

10.1 环境要求

项目要求
Halo>= 2.24.0
LywqPluginCore>= 2.2.0(必需)
PluginPayment>= 2.3.0(可选,付费功能需要)

10.2 配置入口

控制台 -> 插件 -> Tools工具箱 -> 设置

共 11 组配置:

分组说明
基本设置API 认证 Token、免校验角色
支付设置支付开关、免登录支付、渠道映射、同步频率
微信公众号对接appId/appSecret/token、友链、瞬间、评论通知
微信扩展关注回复、关键词回复
随机图开关、类型定义、API 地址
SEO 设置百度 Token、推送频率
文章拓展定时发布、公众号文章搜索
验证码设置验证码规则、公众号获取验证码
模板设置各限制阅读模式的前台模板、PJAX 兼容
弹窗配置弹窗列表及各弹窗详细设置
下载设置主题选择器、下载源列表

Tools工具箱插件-SEO设置.png Tools工具箱插件-文章拓展设置.png Tools工具箱插件-微信拓展设置.png Tools工具箱插件-模板设置.png Tools工具箱插件-验证码设置.png Tools工具箱插件-随机图设置.png Tools工具箱插件-微信公众号对接设置.png Tools工具箱插件-基本设置.png Tools工具箱插件-随机图设置-qkGB.png Tools工具箱插件-下载设置.png Tools工具箱插件-支付设置.png


技术信息

项目说明
许可证LYWQ-AUTH-LICENSE
作者Lywq
官网auth.muyin.site/docs/PluginTools