FIT2CLOUD
文档 的图标

文档

1,017
391

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

1.2.1
tsdaer 发布于
>=2.25.0

升级提示

  • 本版本要求 Halo >= 2.25.0
  • 内容主题设置已完成重构,不再提供 Light、Dark、WeChat、Ant Design 等内置内容主题。
  • 浅色与深色模式现在分别通过“自定义 CSS 地址 + 正文容器 class”配置内容样式。
  • 如果旧版本正在使用内置内容主题,升级后请前往「文档设置」重新配置自定义 CSS;未配置 CSS 或加载失败时,阅读页会使用基础回退样式。
  • 自定义 CSS 地址仅支持 HTTPS 地址或以 / 开头的站内绝对路径。
  • 升级前建议通过「文档设置」导出当前设置和文档快照,并备份 Halo 数据。

新功能

明暗模式独立渲染配置

  • 浅色与深色模式可分别配置:
    • 自定义 Markdown CSS 地址
    • 正文容器 class
    • highlight.js 代码高亮主题
  • 优先识别 Halo 当前主题状态。
  • Halo 使用 auto 或未提供明确主题状态时,自动跟随浏览器的 prefers-color-scheme
  • 主题变化后无需重新生成正文 HTML,即可切换内容 CSS、正文 class 和代码主题。
  • 增强对常见主题 class、data 属性和本地存储主题状态的兼容。

RaTeX 数学公式渲染

  • 新增对 $...$ 行内公式和 $$...$$ 块级公式的渲染支持。
  • 使用 RaTeX WASM + Canvas 在浏览器端渲染公式。
  • Canvas 背景保持透明,公式颜色自动跟随正文实际颜色。
  • 明暗主题切换后自动重新绘制公式颜色。
  • RaTeX 初始化或单个公式渲染失败时,自动回退到 Vditor 数学公式渲染。
  • RaTeX、WASM、字体及相关资源均由插件本地提供,无需依赖外部 CDN。

Markdown 渲染增强

新增或完善以下前台渲染选项:

  • 代码块行号
  • 中英文与数字之间自动空格
  • 裸 URL 自动链接
  • Markdown 脚注
  • ==文字== Mark 标记
  • 常见技术术语大小写修正
  • 正文顶层段落首行缩进
  • Mermaid、Graphviz、ECharts、Markmap 等图表代码块渲染

以上设置仅作用于前台文档阅读页,不会改变后台 Vditor 编辑器的行为。

改进

  • 优化文档设置页的渲染配置布局,使用浅色 / 深色标签分别管理对应设置。
  • 移除效果不稳定的内置内容主题选择,统一改为自定义 CSS 配置。
  • 自定义 CSS 留空或加载失败时保留可读的基础回退样式。
  • 优化主题切换过程中的代码主题和公式颜色刷新逻辑。
  • 修复快速连续切换明暗主题时,旧的延迟刷新可能覆盖当前公式颜色的问题。
  • 调整文档设置页与文档编辑页的自定义代码输入框布局。
  • 规范插件 YAML 配置值格式。
  • 更新文档设置页截图及相关使用文档。

构建与发布

  • 构建流程新增 RaTeX 静态资源处理任务。
  • Vditor、RaTeX、WASM 和数学字体资源会随插件 JAR 一并打包。
  • 新增静态资源反向代理配置,确保前台渲染资源可正常访问。
  • 完善自动发布流程,支持发布至 Halo 应用市场。

兼容性

  • Halo:>= 2.25.0
  • Java:21+
  • v1.1.0 升级时,原有文档库、文档内容、自定义代码、布局配置和代码主题配置均可继续使用。
  • 旧的内置内容主题名称不再生效;已有自定义 CSS 地址与正文 class 会继续保留。

Generated from v1.2.1

资源下载

  • plugin-my-docs-1.2.1.jar
1.2.0
tsdaer 发布于
>=2.25.0

升级提示

  • 本版本要求 Halo >= 2.25.0
  • 内容主题设置已完成重构,不再提供 Light、Dark、WeChat、Ant Design 等内置内容主题。
  • 浅色与深色模式现在分别通过“自定义 CSS 地址 + 正文容器 class”配置内容样式。
  • 如果旧版本正在使用内置内容主题,升级后请前往「文档设置」重新配置自定义 CSS;未配置 CSS 或加载失败时,阅读页会使用基础回退样式。
  • 自定义 CSS 地址仅支持 HTTPS 地址或以 / 开头的站内绝对路径。
  • 升级前建议通过「文档设置」导出当前设置和文档快照,并备份 Halo 数据。

新功能

明暗模式独立渲染配置

  • 浅色与深色模式可分别配置:
    • 自定义 Markdown CSS 地址
    • 正文容器 class
    • highlight.js 代码高亮主题
  • 优先识别 Halo 当前主题状态。
  • Halo 使用 auto 或未提供明确主题状态时,自动跟随浏览器的 prefers-color-scheme
  • 主题变化后无需重新生成正文 HTML,即可切换内容 CSS、正文 class 和代码主题。
  • 增强对常见主题 class、data 属性和本地存储主题状态的兼容。

RaTeX 数学公式渲染

  • 新增对 $...$ 行内公式和 $$...$$ 块级公式的渲染支持。
  • 使用 RaTeX WASM + Canvas 在浏览器端渲染公式。
  • Canvas 背景保持透明,公式颜色自动跟随正文实际颜色。
  • 明暗主题切换后自动重新绘制公式颜色。
  • RaTeX 初始化或单个公式渲染失败时,自动回退到 Vditor 数学公式渲染。
  • RaTeX、WASM、字体及相关资源均由插件本地提供,无需依赖外部 CDN。

Markdown 渲染增强

新增或完善以下前台渲染选项:

  • 代码块行号
  • 中英文与数字之间自动空格
  • 裸 URL 自动链接
  • Markdown 脚注
  • ==文字== Mark 标记
  • 常见技术术语大小写修正
  • 正文顶层段落首行缩进
  • Mermaid、Graphviz、ECharts、Markmap 等图表代码块渲染

以上设置仅作用于前台文档阅读页,不会改变后台 Vditor 编辑器的行为。

改进

  • 优化文档设置页的渲染配置布局,使用浅色 / 深色标签分别管理对应设置。
  • 移除效果不稳定的内置内容主题选择,统一改为自定义 CSS 配置。
  • 自定义 CSS 留空或加载失败时保留可读的基础回退样式。
  • 优化主题切换过程中的代码主题和公式颜色刷新逻辑。
  • 修复快速连续切换明暗主题时,旧的延迟刷新可能覆盖当前公式颜色的问题。
  • 调整文档设置页与文档编辑页的自定义代码输入框布局。
  • 规范插件 YAML 配置值格式。
  • 更新文档设置页截图及相关使用文档。

构建与发布

  • 构建流程新增 RaTeX 静态资源处理任务。
  • Vditor、RaTeX、WASM 和数学字体资源会随插件 JAR 一并打包。
  • 新增静态资源反向代理配置,确保前台渲染资源可正常访问。
  • 完善自动发布流程,支持发布至 Halo 应用市场。

兼容性

  • Halo:>= 2.25.0
  • Java:21+
  • v1.1.0 升级时,原有文档库、文档内容、自定义代码、布局配置和代码主题配置均可继续使用。
  • 旧的内置内容主题名称不再生效;已有自定义 CSS 地址与正文 class 会继续保留。

Generated from v1.2.0

资源下载

  • plugin-my-docs-1.2.0.jar
v1.1.0
tsdaer 发布于
>=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 辅助编写:文档设置页提供「后台代码片段」与「扩展插件开发」提示词一键复制

资源下载

  • plugin-my-docs-1.1.0.jar