ToolBench插件指南 发布于 2

焕然一新

更多扩展尽在Tool Bench

安装插件

动指间的功夫，就能享受Tool Bench带来的好处

插件功能

Tool Bench 是一款非常强大功能型插件，它为绝大多数主题、插件提供了更好的扩展能力和一些API支持。它包含了如下的一些功能：

• 提供对接到 GitHub 仓库信息的内建 API 接口
• 提供对接到和风天气API的内建 API 接口
• 支持在页面中使用 AntV X6 图编辑引擎
• 支持在页面中使用 AntV G2 可视化语法
• Tool Bench 的尺寸自适应表达式
• 新增的目录页模板，使用/directory进行访问（需要主题支持）
• 允许任何主题、任何插件支持自己的扩展的自定义标签
• <tool-xxx>系列小标签（将在1.0.5版本后分离）

目前插件仍处于开发初阶段，仍有很多功能在计划开发的日程中，在后面的版本迭代中会逐步跟进。若读者有其他的想法或建议都欢迎与我进行交流。

• font-awesome等图标支持（移步至了Spring-Mono主题）
• 支付宝当面付能力
• 邮件通知模板

我们接纳所有合理和有价值的提议，您可以在 GitHub 的 issue 页面提供您的想法，或加入我们的 QQ 交流群 697197698 一同探讨。

扩展样式

对于1.0.4及以前的版本，插件提供了与</tool-xxx>相关的自定义元素和标签，这些样式的撰写指南和演示你可以在《ToolBench样式指南》文章中找到。

如果您是主题开发者或插件开发者，并且在您的项目中开发了与自定义 DOM 标签相关的代码，同时希望你的自定义 DOM 标签能在页面、文章中被渲染，那么您可以使用 Tool Bench 插件作为前置插件。本插件在配置中为任何主题、任何插件都提供了支持自己的扩展的自定义标签的能力。在您的主题、插件发布页面中提醒您的使用者安装本插件，并前往插件设置 → 渲染增强 → 标签前缀中添加您的标签支持，这里举一些例子：

• 在Joe3.0主题中开发了<joe-xxx>标签，那么只需要在插件设置 → 渲染增强 → 标签前缀中添加"joe"
• 在Halo-Theme-Hao扩展的主题中开发了<hao-xxx>标签，那么只需要在插件设置 → 渲染增强 → 标签前缀中添加"hao"

使用与开发

目录页

插件提供了目录页/directory的路由支持，各主题开发者可以参考《Thymeleaf目录页原理》实现该目录页面的能力。

重写样式

对于1.0.4及以前的版本，插件为自定义元素、标签提供的样式并不能完全满足所有主题的需求（如存在白天、夜间模式切换的主题）。为此有需求的用户可以通过重写样式实现自己的需求，参考resources/css/tool-bench.css的所有class进行重写可以实现自己想要的样式需求。

插件开发

在拉取ToolBench插件的仓库后使用Gradle与JDK 17进行构建，在源码中提供了一些常用的工具类和框架，开发者可以根据自己的需要来使用开发。本篇不会用过多的篇幅介绍如何开发，相关的内容正在撰写新的文章，敬请期待。

注意事项

如果这里没有你的问题的解决方案请在评论区与我取得联系

1. 在Tool Bench中集成的AntV功能是默认关闭的，以节省页面资源，如果需要使用请在配置中开启它。
2. GitHub Token必须是启用了“获取仓库”能力的才能有效。
3. 确保你的服务器能访问到GitHub，否则你的<tool-github>会永远处于一直加载状态。
4. 这些自定义的元素、标签并不是在所有主题中都显得好看，如需要修改请查看“重写样式”。

参与贡献

如果你想提供帮助并一同完善 Tool Bench 插件，请：

• 点star
• 提issue
• 修bugs
• 推pr

鸣谢

在此感谢以下项目提供的支持：

• Halo
• Typecho Themes Joe
• Halo Theme Joe2.0
• AntV X6 图编辑引擎
• AntV G2 可视化语法