FIT2CLOUD
文档 的图标

文档

1,398
514

一个为Halo提供文档 / 知识库能力的插件。 my-docs在 Halo 原有文章与页面模型之外,补充一套独立的文档系统,用来承载产品手册、开发文档、帮助中心这类需要树形目录和连续阅读体验的内容。

1.3.0
tsdaer 发布于
>=2.25.0

摘要

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

本版本为 v1.3.0,适用于 Halo >= 2.25.0

本版重点

GitHub Wiki 导入

  • 双通道导入:输入 owner/repo 或完整 GitHub 地址由服务器浅克隆 .wiki.git 拉取(私有 Wiki 支持 PAT 令牌);服务器无法直连 GitHub 时可上传 clone 后打包的 zip
  • Wiki 链接自动转换[[Page]][[Page|文字]][[Page#锚点]] 转换为站内同库短链接;找不到对应页面时降级为纯文本并在导入报告中提示
  • 导入行为:页面文件名作为标题,Home 排最前;_Sidebar / _Header / _Footer 自动跳过;可选导入到已有文档库(别名冲突自动追加序号)或新建文档库;可指定导入后立即发布或保持草稿
  • 导入入口位于文档库列表页、文档库行内菜单与文档管理页

优化与修复

  • 加固文档端点校验:PUT 路径名与请求体一致性、所属文档库存在性
  • 搜索索引同步去重:插件重启后的全量 resync 不再反复重建索引;修复文档删除后搜索索引残留
  • Markdown 渲染器实例复用:前台每页视图渲染不再重建解析器实例,提升阅读页性能
  • 修复开发工具链:eslint 无法加载 TypeScript 配置的问题

安装

  1. 在 Release 附件中下载 plugin-my-docs-1.3.0.jar
  2. 进入 Halo Console。
  3. 打开「插件」页面并上传该 jar。
  4. 安装并启用 my-docs

升级

  1. 备份当前 Halo 数据。
  2. 在维护窗口内上传新版本 jar。
  3. 启用后检查:文档库列表是否正常加载、搜索索引是否完整。

Generated from v1.3.0

资源下载

  • plugin-my-docs-1.3.0.jar