use vscode-markdown-it-katex to render KaTex

yzane · Nov 10, 2024 · cb6d9a5 · cb6d9a5
1 parent 373a7f1
commit cb6d9a5
Show file tree

Hide file tree

Showing 7 changed files with 68 additions and 0 deletions.
diff --git a/README.ja.md b/README.ja.md
@@ -36,6 +36,7 @@
 * [markdown-it-checkbox](https://github.com/mcecot/markdown-it-checkbox)
 * [markdown-it-container](https://github.com/markdown-it/markdown-it-container)
 * [markdown-it-include](https://github.com/camelaissani/markdown-it-include)
+* [markdown-it-katex](https://github.com/microsoft/vscode-markdown-it-katex)
 * [PlantUML](https://plantuml.com/)
   * [markdown-it-plantuml](https://github.com/gmunguia/markdown-it-plantuml)
 * [mermaid](https://mermaid-js.github.io/mermaid/)
@@ -105,6 +106,21 @@ Content of plugins/README.md
 Content of CHANGELOG.md
 ```
 
+### markdown-it-katex
+
+INPUT
+
+```
+$$
+\sqrt{3x-1}+(1+x)^2
+$$
+```
+
+OUTPUT
+
+![katex](images/katex.png)
+
+
 ### mermaid
 
 INPUT

diff --git a/README.md b/README.md
@@ -38,6 +38,7 @@ Supports the following features
 * [markdown-it-checkbox](https://github.com/mcecot/markdown-it-checkbox)
 * [markdown-it-container](https://github.com/markdown-it/markdown-it-container)
 * [markdown-it-include](https://github.com/camelaissani/markdown-it-include)
+* [markdown-it-katex](https://github.com/microsoft/vscode-markdown-it-katex)
 * [PlantUML](https://plantuml.com/)
   * [markdown-it-plantuml](https://github.com/gmunguia/markdown-it-plantuml)
 * [mermaid](https://mermaid-js.github.io/mermaid/)
@@ -107,6 +108,20 @@ Content of plugins/README.md
 Content of CHANGELOG.md
 ```
 
+### markdown-it-katex
+
+INPUT
+
+```
+$$
+\sqrt{3x-1}+(1+x)^2
+$$
+```
+
+OUTPUT
+
+![katex](images/katex.png)
+
 ### mermaid
 
 INPUT

diff --git a/images/katex.png b/images/katex.png
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -494,6 +494,7 @@
     "vscode-test": "^1.3.0"
   },
   "dependencies": {
+    "@vscode/markdown-it-katex": "^1.1.0",
     "cheerio": "^0.20.0",
     "emoji-images": "^0.1.1",
     "gray-matter": "^4.0.2",

diff --git a/src/extension.js b/src/extension.js
@@ -219,6 +219,9 @@ function convertMarkdownToHtml(filename, type, text) {
   // checkbox
   md.use(require('markdown-it-checkbox'));
 
+  // katex
+  md.use(require('@vscode/markdown-it-katex').default);
+
   // emoji
   var emoji_f = setBooleanValue(matterParts.data.emoji, vscode.workspace.getConfiguration('markdown-pdf')['emoji']);
   if (emoji_f) {

diff --git a/template/template.html b/template/template.html
@@ -4,6 +4,7 @@
 <title>{{{title}}}</title>
 <meta http-equiv="Content-type" content="text/html;charset=UTF-8">
 {{{style}}}
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css" integrity="sha384-nB0miv6/jRmo5UMMR1wu3Gz6NLsoTkbqJghGIsx//Rlm+ZU03BU6SQNC66uf4l5+" crossorigin="anonymous">
 {{{mermaid}}}
 </head>
 <body>