Release my-docs v1.0.0 · tsdaer/plugin-my-docs

my-docs 为 Halo 提供独立的文档 / 知识库系统,支持文档库、树形目录、Markdown 编辑、前台文档站点、搜索与 SEO 集成。

首个正式版本 v1.0.0,适用于 Halo >= 2.25.0。

主要功能

文档库管理:创建、编辑、删除文档库,支持描述与封面
树形编排:在 Console 中拖拽调整目录树与同级顺序,支持父子层级与排序权重
Markdown 编辑:独立 Vditor 编辑器,支持从 Halo 附件库插入图片、附件与站内文档链接
前台文档站点:提供 /docs、/docs/{librarySlug}、/docs/{librarySlug}/{docSlug} 页面,含侧边目录树与可配置布局的文档库首页
阅读增强:正文大纲、滚动高亮、同库标题短链接跳转、移动端折叠目录,并跟随 Halo 主题切换
搜索与 SEO:已发布文档接入 Halo 搜索,并输出页面级 SEO 元信息
公共访问接口:仅暴露已发布文档的只读 API,避免草稿泄露
备份与恢复:文档设置页支持导出 / 加载设置,快照含插件设置、文档库与文档 Markdown 内容
自定义代码注入:支持在全局、文档库、单篇文档三个层级注入自定义 head / body 代码(HTML / CSS / JS),按全局 → 文档库 → 文档顺序叠加
扩展点机制:对外开放 DocContentHandler(正文后处理)与 DocDetailModelHandler(阅读页 Model 注入)两个扩展点
AI 辅助编写:文档设置页提供「后台代码片段」与「扩展插件开发」提示词一键复制

启用后,Console 侧边栏出现「文档」与「文档设置」入口,前台访问 /docs 即可。