Skip to content

v1.0.0

Choose a tag to compare

@cosolar cosolar released this 31 Aug 10:44
· 8 commits to master since this release

MiniDocs 知识库 v1.0.0

MiniDocs 是 Halo 2.x 的轻量知识库插件,用于搭建团队 / 个人知识库:多知识库管理、文档树、Markdown 编辑、分类标签与权限控制,并将知识库内容通过公开接口与 Finder 暴露给第三方主题,方便开发用户侧文档站点。

插件同时提供 Console 管理界面、minidocsFinder Finder API 和匿名公共 REST API,适用于传统 Thymeleaf 主题和前端框架渲染的文档页。

目标平台:Halo >= 2.26.0

功能特性

  • 知识库管理:支持多知识库创建、编辑、删除,公开 / 私有切换、成员授权与排序。
  • 文档管理:支持文档树层级、Markdown 编辑、slug 别名、发布 / 草稿状态、标签与封面。
  • 分类标签:知识库与文档均支持标签,便于按主题归类与检索。
  • 权限控制:内置「知识库查看」「知识库管理」角色模板;私有知识库可指定成员(可访问者)列表,服务端按「创建者 / 成员 / 管理员」做资源级访问校验;可开关「允许未登录用户阅读公开知识库」控制匿名访问。
  • 文档发布:支持单篇文档发布,发布后内容通过公开接口与 Finder 对外可见。
  • 文档导入导出:支持批量导入(同名知识库安全覆盖、失败自动回滚保留原数据),以及将文档导出为 Markdown(受导出开关约束)。
  • 外链分享:知识库卡片可一键开启外链分享,生成 /docs/share/{token} 对外链接,支持可选访问密码与有效期,分享页与阅读页同布局且无需登录。
  • 主题适配:提供 minidocsFinder Finder API 与匿名公共 REST API,便于主题渲染知识库列表、文档树与文档详情。