MarkdownIt 插件@mdit/plugin-katex怎么使用
时间: 2024-09-25 20:17:40 浏览: 16
MarkdownIt 插件 `@mdit/plugin-katex` 是用于增强 Markdown 文件渲染支持 LaTeX 公式编写的工具,它配合 Markdown 库 MarkdownIt 使用。要在项目中使用这个插件,你需要按照以下步骤操作:
1. **安装**:
首先,在你的 Node.js 项目中安装 `markdown-it` 和 `@mdit/plugin-katex`。打开终端,运行:
```
npm install markdown-it markdown-it-katex
```
2. **配置**:
在你的 `.js` 或 `.ts` 文件中,加载并启用该插件。例如,如果你使用的是 JavaScript:
```javascript
const md = require('markdown-it')();
md.use(require('markdown-it-katex'));
```
如果你在 TypeScript 项目中,记得导入类型定义文件:
```typescript
import * as md from 'markdown-it';
import katexPlugin from 'markdown-it-katex';
md.use(katexPlugin);
```
3. **插入公式**:
在 Markdown 文档中编写 LaTeX 语法的公式,如 `$\alpha + \beta$`。MarkdownIt 会自动识别它们,并通过 KaTeX 进行渲染。
4. **运行解析**:
最后,将处理后的 HTML 结果返回:
```javascript
let html = md.render('# Your Markdown Content with a formula: \( E = mc^2 \)');
console.log(html);
```