From da31ec527b39808fec2a4e074fb0433a6add2328 Mon Sep 17 00:00:00 2001 From: Ryan Wang Date: Sun, 24 Sep 2023 21:06:10 +0800 Subject: [PATCH 1/2] docs: refine usage documentations (#11) --- README.md | 34 ++++++++++++--------- src/main/resources/extensions/settings.yaml | 8 ++--- 2 files changed, 23 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 4813657..13b3406 100644 --- a/README.md +++ b/README.md @@ -16,32 +16,36 @@ 在默认编辑器中,使用 `$` 开头和结尾的语句将会被渲染为 KaTeX 行内公式,输入 `$$` 并回车可以插入 KaTeX 块级公式。 ### 文章页渲染公式 -此插件安装之后,文章页使用KaTeX.js渲染公式,插件支持2个配置项。 -1. inline_selector - -CSS-Selector语法,用来查找渲染的行内公式Dom。 -默认值为:`[math-inline]`(本插件扩展默认编辑器生成的行内公式Dom),如需兼容其他编辑器,则设置为相应的Selector即可。 +此插件安装之后,文章页使用 KaTeX.js 渲染公式,插件支持 2 个配置项。 -example: +1. 行内公式 CSS 选择器 -bytemd: `.math-inline` + CSS Selector 语法,用来查找渲染的行内公式 Dom。 -stackedit: `.katex--inline` + 默认值为:`[math-inline]`(本插件扩展默认编辑器生成的行内公式 Dom),如需兼容其他编辑器,则设置为相应的 Selector 即可。 -如同时使用多个编辑器,CSS Selector之间用`,`隔开即可。 + 已知编辑器: -example:`[math-inline],.math-inline,.katex--inline` + [ByteMD](https://www.halo.run/store/apps/app-HTyhC):`.math-inline` -2. display_selector + [StackEdit](https://www.halo.run/store/apps/app-hDXMG):`.katex--inline` -CSS-Selector语法,用来查找渲染的块级公式Dom。 + 如同时使用多个编辑器,CSS Selector 之间用 `,` 隔开即可。 -默认值为:`[math-display]` + 如:`[math-inline],.math-inline,.katex--inline` -bytemd: `.math-display` +2. 块级公式 CSS 选择器 -stackedit: `.katex--display` + CSS Selector 语法,用来查找渲染的块级公式 Dom。 + + 默认值为:`[math-display]` + + 已知编辑器: + + [ByteMD](https://www.halo.run/store/apps/app-HTyhC):`.math-display` + + [StackEdit](https://www.halo.run/store/apps/app-hDXMG):`.katex--display` ## 开发环境 diff --git a/src/main/resources/extensions/settings.yaml b/src/main/resources/extensions/settings.yaml index 370f1b9..f3d729b 100644 --- a/src/main/resources/extensions/settings.yaml +++ b/src/main/resources/extensions/settings.yaml @@ -9,11 +9,11 @@ spec: formSchema: - $formkit: text name: inline_selector - label: 行内公式CSS选择器 + label: 行内公式 CSS 选择器 value: "[math-inline]" - help: 用于匹配行内公式的CSS选择器 + help: 用于匹配行内公式的 CSS 选择器 - $formkit: text name: display_selector - label: 块级公式CSS选择器 + label: 块级公式 CSS 选择器 value: "[math-display]" - help: 用于匹配块级公式的CSS选择器 + help: 用于匹配块级公式的 CSS 选择器 From fb1c1ceebaa33528f01bd43a958b30a17a1717fb Mon Sep 17 00:00:00 2001 From: "1152958806@qq.com" <17683872107czx> Date: Mon, 9 Oct 2023 16:14:58 +0800 Subject: [PATCH 2/2] =?UTF-8?q?katex=E8=B0=83=E7=94=A8=E6=96=B9=E6=B3=95?= =?UTF-8?q?=E5=B0=81=E8=A3=85=EF=BC=8C=E6=8F=90=E4=BE=9B=E7=BB=99=E4=B8=BB?= =?UTF-8?q?=E9=A2=98=E8=B0=83=E7=94=A8=EF=BC=8C=E8=A7=A3=E5=86=B3pjax?= =?UTF-8?q?=E9=80=82=E9=85=8D=E6=80=A7=E9=97=AE=E9=A2=98?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/main/java/run/halo/katex/KaTeXJSInjector.java | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/main/java/run/halo/katex/KaTeXJSInjector.java b/src/main/java/run/halo/katex/KaTeXJSInjector.java index 7e3ff25..2f09485 100644 --- a/src/main/java/run/halo/katex/KaTeXJSInjector.java +++ b/src/main/java/run/halo/katex/KaTeXJSInjector.java @@ -6,7 +6,7 @@ static String getParsedKatexScript(String inline_selector, String display_select """;