Docsme 文档管理

问题修复

• 修复在包含多语言文档的场景时，访问文档首页后无法切换语言的问题

问题修复

• 修复无法渲染 KaTeX 公式的问题

问题修复

• 修复文档删除之后，仍然可以搜索到文档的问题

注意：如果升级之后搜索仍然有问题，可以尝试在仪表盘的快捷访问中刷新搜索引擎索引。

问题修复

• 修复文档内容无法显示斜体样式的问题

问题修复

• 修复文档设置为禁止公开访问后，直接访问文档详情页面仍然可以访问的问题

问题修复

• 修复文档内容中任务列表的样式问题

重要变更

为了获得更好的体验，此版本移除了内置的 Prism 代码块高亮依赖，改为集成额外的代码高亮插件。升级到此版本之后，请进行以下操作：

1. 安装 Shiki 代码高亮（推荐）或者 highlight.js 代码高亮
2. 在插件设置中添加 /docs/** 规则。

新特性

• 深度适配 Shiki 代码高亮插件
  • 支持在 Halo 编辑器中使用 Shiki 渲染代码块高亮
  • 支持 Markdown 预览时使用 Shiki 渲染代码块高亮

Full Changelog: v1.1.0...v1.2.0

⚠️ 提示

1.0.1 之后的版本添加了许可证校验，需要通过 Halo 专业版或者插件的许可证激活之后才能正常启用，所以在更新之前请确保已经有了对应的许可证。

关于此插件的发行方式请查阅：https://www.halo.run/store/apps/app-yffxw

新特性

• 为文档项目增加权限管理机制，支持为角色或者单个用户设置管理、编辑、只读权限。
• 文档项目添加 禁止公开访问 选项。
• 编辑器支持转存外部媒体资源。

问题修复

• 解决将粘贴 Excel 内容会变为图片的问题。

注意事项

• 如果需要让用户支持在编辑器中上传图片，需要提前给用户分配一个包含 允许管理自己的附件 的权限。
• 如果文档项目开启了 禁止公开访问 选项，那么只有超级管理员或者至少包含只读权限的用户可访问文档。

⚠️ 提示

1.0.1 之后的版本添加了许可证校验，需要通过 Halo 专业版或者插件的许可证激活之后才能正常启用，所以在更新之前请确保已经有了对应的许可证。

关于此插件的发行方式请查阅：https://www.halo.run/store/apps/app-yffxw

功能优化

• 添加菜单/路由权限判断。（需要升级到 Halo 2.21.7）

⚠️ 提示

1.0.1 之后的版本添加了许可证校验，需要通过 Halo 专业版或者插件的许可证激活之后才能正常启用，所以在更新之前请确保已经有了对应的许可证。

关于此插件的发行方式请查阅：https://www.halo.run/store/apps/app-yffxw

问题修复

• 修复使用 Markdown 编辑器时，无法预览的问题。

⚠️ 提示

1.0.1 之后的版本添加了许可证校验，需要通过 Halo 专业版或者插件的许可证激活之后才能正常启用，所以在更新之前请确保已经有了对应的许可证。

关于此插件的发行方式请查阅：https://www.halo.run/store/apps/app-yffxw

新特性

• 为文档项目增加权限管理机制，支持为角色或者单个用户设置管理、编辑、只读权限。
• 文档项目添加 禁止公开访问 选项。

注意事项

• 由于需要针对单个项目设置权限，没有利用 Halo 本身的权限机制，所以在 Console 和 UC 端，文档菜单将暂时开放给所有已登录的用户，如果用户没有任何文档的访问权限，不会显示任何数据。
• 如果需要让用户支持在编辑器中上传图片，需要提前给用户分配一个包含 允许管理自己的附件 的权限。
• 如果文档项目开启了 禁止公开访问 选项，那么只有超级管理员或者至少包含只读权限的用户可访问文档。

⚠️ 提示

1.0.1 之后的版本添加了许可证校验，需要通过 Halo 专业版或者插件的许可证激活之后才能正常启用，所以在更新之前请确保已经有了对应的许可证。

关于此插件的发行方式请查阅：https://www.halo.run/store/apps/app-yffxw

问题修复

• 修复暗黑模式切换以及 TOC 功能无法使用的问题。

⚠️ 提示

1.0.1 之后的版本添加了许可证校验，需要通过 Halo 专业版或者插件的许可证激活之后才能正常启用，所以在更新之前请确保已经有了对应的许可证。

关于此插件的发行方式请查阅：https://www.halo.run/store/apps/app-yffxw

功能优化

• 优化提示块在暗黑模式下的样式。

问题修复

• 修复浏览器控制台 JavaScript 异常的问题。
• 修复文档列表页面图标大小的样式问题。

⚠️ 提示

1.0.1 之后的版本添加了许可证校验，需要通过 Halo 专业版或者插件的许可证激活之后才能正常启用，所以在更新之前请确保已经有了对应的许可证。

关于此插件的发行方式请查阅：https://www.halo.run/store/apps/app-yffxw

问题修复

• 修复使用 Halo 编辑器发布时，可能出现页面卡死的问题。

⚠️ 提示

1.0.1 之后的版本添加了许可证校验，需要通过 Halo 专业版或者插件的许可证激活之后才能正常启用，所以在更新之前请确保已经有了对应的许可证。

关于此插件的发行方式请查阅：https://www.halo.run/store/apps/app-yffxw

问题修复

• 修复 Markdown 文档导入时，encode 过的图片链接无法导入的问题。

⚠️ 提示

此版本添加了许可证校验，需要通过 Halo 专业版或者插件的许可证激活之后才能正常启用，所以在更新之前请确保已经有了对应的许可证。

关于此插件的发行方式请查阅：https://www.halo.run/store/apps/app-yffxw

功能优化

• 添加许可证校验。
• 文档导入支持同时上传关联的图片。

问题修复

• 修复 Halo 编辑器无法通过粘贴上传图片的问题。

🎉 正式版发布

此插件已经正式发布 1.0.0 版本，此前承诺在测试阶段提供有效反馈的用户可以在正式版发布之后赠送折扣券，但后面因为凌霞软件商业相关的调整，Halo 官方应用市场已经不再独立销售付费应用，而是改为仅限 Halo 专业版使用，所以现对此前的公告做出调整。

1. 赠送 Halo 专业版的 5 折优惠券，请发送 Halo 官网以及凌霞软件官网的用户名到 ruiyuan.wang@fit2cloud.com。反馈收集截止日期为 2025 年 7 月 15 日，优惠券使用日期截止到 2025 年 8 月 1 日。
2. 公开未来 3 个版本的免授权版本的下载地址，之后的版本可能无法得到更新。
3. 面向 Halo 生态的开发者免费，如果你满足以下要求，请发送邮件到 ruiyuan.wang@fit2cloud.com 申请。（此方式永久有效）
   1. 对 halo-dev 和 halo-sigs 组织下的仓库有过 PR 贡献。
   2. 在 Halo 应用市场上架过插件或者主题。

功能优化

• 文档导入功能支持解析 Front Matter 中的 description 字段。
• 优化文档图片的间距样式。

预告

此插件即将发布 1.0.0 正式版本，此前承诺在测试阶段提供有效反馈的用户可以在正式版发布之后赠送折扣券，但后面因为凌霞软件商业相关的调整，Halo 官方应用市场已经不再独立销售付费应用，而是改为仅限 Halo 专业版使用，所以现对此前的公告做出调整。

1. 赠送 Halo 专业版的 5 折优惠券，请发送 Halo 官网以及凌霞软件官网的用户名到 ruiyuan.wang@fit2cloud.com。反馈收集截止日期为 2025 年 7 月 15 日，优惠券使用日期截止到 2025 年 8 月 1 日。
2. 公开未来 3 个版本的免授权版本的下载地址，之后的版本可能无法得到更新。
3. 面向 Halo 生态的开发者免费，如果你满足以下要求，请发送邮件到 ruiyuan.wang@fit2cloud.com 申请。（此方式永久有效）
   1. 对 halo-dev 和 halo-sigs 组织下的仓库有过 PR 贡献。
   2. 在 Halo 应用市场上架过插件或者主题。

以上调整在正式版发布后生效。

新特性

• 重构默认模板，优化主题集成的方式，文档：主题适配 - Docsme
• 文档和目录支持设置描述。

问题修复

• 修复 1.0.0-rc.1 中文档目录页面报错的问题。

预告

此插件即将发布 1.0.0 正式版本，此前承诺在测试阶段提供有效反馈的用户可以在正式版发布之后赠送折扣券，但后面因为凌霞软件商业相关的调整，Halo 官方应用市场已经不再独立销售付费应用，而是改为仅限 Halo 专业版使用，所以现对此前的公告做出调整。

1. 赠送 Halo 专业版的 5 折优惠券，请发送 Halo 官网以及凌霞软件官网的用户名到 ruiyuan.wang@fit2cloud.com。反馈收集截止日期为 2025 年 7 月 15 日，优惠券使用日期截止到 2025 年 8 月 1 日。
2. 公开未来 3 个版本的免授权版本的下载地址，之后的版本可能无法得到更新。
3. 面向 Halo 生态的开发者免费，如果你满足以下要求，请发送邮件到 ruiyuan.wang@fit2cloud.com 申请。（此方式永久有效）
   1. 对 halo-dev 和 halo-sigs 组织下的仓库有过 PR 贡献。
   2. 在 Halo 应用市场上架过插件或者主题。

以上调整在正式版发布后生效。

新特性

• 重构默认模板，优化主题集成的方式，文档：主题适配 - Docsme
• 文档和目录支持设置描述。

新特性

• 支持 Halo 默认编辑器。
• 支持为文档开启评论。
• 支持导入 Markdown 文档。

功能优化

• 优化文档页面标题。

问题修复

• 修复 alpha.11 中无法加载 UI 资源的问题。

功能优化

• 降低 bundle.js 的大小，提升 Console 访问速度。

问题修复

• 修复当内容为空时构建全文搜索文档项出现 NPE 的问题。

Generated from v1.0.0-alpha.10

功能优化

• 适配 Halo 新的搜索机制。
• 将文档的菜单项改为仅超级管理员可见。
• 修改文档版本时，不允许修改 基于版本 的选项，防止造成错误。

重要提示

建议及时更新到此版本，Halo 未来的版本将移除旧版本中使用的过时 API，此版本为兼容版本。

功能优化

• 使用 Halo 2.17 新提供的全局 axios 实例和 apiClient 重构请求逻辑，优化异常提示和捆绑包大小。
• 移除 Halo 中过时的 API。

问题修复

• 解决无法在 Halo 2.17 上正常运行的问题。

问题修复

• 修复项目别名修改之后文档访问地址没有跟随改变的问题。

功能优化

• 更新插件描述文件。

新特性

• 新增对 Markdown 提示块的语法支持。

问题修复

• 修复搜索接口错误的问题。

新特性

• 文档及其文档树支持展示有内容未发布的状态。
• 新增文档全文搜索功能。
• 新增 /docs 路由用于展示所有文档项目。

功能优化

• 使用索引机制优化查询。
• 完善默认主题，解决一些遗留问题。
• 当文档项目未设置 icon 时，在编辑页面不加载 Logo 组件。

问题修复

• 修复基于版本复制时 Doc 中引用的 docTreeName 不正确的问题。
• 修复文档路由改变后没有清除旧的路由导致仍然可以访问的问题。
• 修复在编辑页面中开启全屏模式之后，项目设置等弹框无法打开的问题。
• 修复未发布的文档被列出在文档树中的问题。
• 修复项目、文档、版本表单中，别名不能为单个字符的问题。

问题修复

• 修复项目创建者可能没有正确设置的问题。
• 修复项目卡片无法正确显示文档数量的问题。
• 优化访问未发布的文档时的错误提示。
• 修复别名可以为空的问题。
• 修复在发布文档前没有保存当前内容的问题。
• 修复创建项目时，未设置图标时导致访问页面报错的问题。

功能优化

• 为项目、项目版本、同层级文档添加 slug 唯一验证。

首个版本发布 🎉

特性

• 支持创建多个文档项目，每个项目相互独立。
• 支持多语言，每个项目可以创建多个语言版本。
• 支持多版本，每个项目可以创建多个版本。
• 自带 Markdown 编辑器。
• 内置模板，无需主题支持，但也可以通过主题自定义模板。