Akvicor
Akvicor
发布于 2026-04-30 / 24 阅读
0
2

KMath: halo官方数学渲染插件的增强版插件

GitHub仓库地址:https://github.com/Akvicor/plugin-kmath

为默认编辑器和文章渲染提供数学公式支持(KaTeX / MathJax)。

使用方式

  1. 下载,目前提供以下两个下载方式:

  2. 安装,插件安装和更新方式可参考:https://docs.halo.run/user-guide/plugins

用法说明

配置项说明

KaTeX 输出格式katex_output

支持三种输出格式:

  • mathml:输出 MathML 结构。

  • html:输出 HTML 结构。

  • htmlAndMathml:同时输出 HTML + MathML。

插件默认值为mathml

实际生效范围:

  • 控制台默认编辑器在使用 KaTeX 引擎时的渲染输出。

  • 前台在使用 KaTeX 引擎并执行客户端渲染时的输出结构。

前台渲染引擎render_engine

可选 katex / mathjax,用于控制控制台默认编辑器和前台客户端渲染时使用的引擎。

  • 该配置会影响控制台默认编辑器中的预览与保存内容的渲染结构。

  • enable_frontend_render=false 时,不执行前台客户端二次渲染流程。

  • 即使不执行二次渲染,仍会根据引擎注入对应的基础样式(KaTeX CSS 或 MathJax SVG 样式)。

启用客户端公式渲染enable_frontend_render

  • false:不注入前台渲染脚本。

  • true:按下述选择器查找公式节点,并使用 render_engine 在前台渲染。

行内公式 CSS 选择器inline_selector

CSS Selector 语法,用于查找前台待渲染的行内公式 DOM。

如同时使用多个编辑器,CSS Selector 之间用 , 隔开即可。

[math-inline],.math-inline,.katex--inline

块级公式 CSS 选择器display_selector

CSS Selector 语法,用于查找前台待渲染的块级公式 DOM。

在默认编辑器中使用

  • 方式一:在默认编辑器中,使用 $ 开头和结尾的语句将会被渲染为 KaTeX 行内公式,输入 $$ 并回车可以插入 KaTeX 块级公式。

  • 方式二:在编辑器顶部工具栏的工具箱中点击 KaTeX 块级公式 或者 KaTeX 行内公式 即可插入块级公式和行内公式。

  • 方式三:在指令菜单(/)中选择 KaTeX 块级公式 或者 KaTeX 行内公式 即可插入块级公式和行内公式。

在默认编辑器中使用,编辑器将会自动生成相应的 DOM 结构,无需进行其他配置。

配置简述

  • katex_output:会直接影响使用 KaTeX 引擎时编辑器预览与保存内容的输出结构。

  • render_engine:会影响编辑器内预览、保存内容的渲染结构,以及前台页面侧的渲染链路。

  • enable_frontend_render=false:前台不做二次渲染;是否正常显示取决于已保存结构与当前样式支持。

  • 若希望前台强制统一为 MathJax 效果:设置 render_engine=mathjaxenable_frontend_render=true


评论