treeSitter()

创建 Tree-sitter 插件，使用 Tree-sitter 解析库为围栏代码块启用语法高亮。

import { treeSitter } from "@unifast/node";

签名

function treeSitter(options?: TreeSitterPluginOptions): UnifastPlugin

参数

options?

高亮引擎的配置

属性类型默认值描述
engine"none" | "treeSitter""treeSitter""treeSitter" 使用 Tree-sitter 高亮器；"none" 则禁用高亮

用法

import { compile, treeSitter } from "@unifast/node";

const md = `
# Code Example

\`\`\`rust
fn main() {
    println!("Hello, world!");
}
\`\`\`
`;

const result = compile(md, {
  plugins: [
    treeSitter({
      engine: "treeSitter",
    }),
  ],
});

console.log(result.output);
// Code blocks are syntax highlighted with <span> elements and CSS classes

示例

启用语法高亮

import { compile, treeSitter } from "@unifast/node";

const md = `
\`\`\`typescript
const greeting: string = "Hello";
console.log(greeting);
\`\`\`
`;

const result = compile(md, { plugins: [treeSitter()] });

console.log(result.output);
// <pre><code class="language-typescript">
//   <span class="...">const</span> ...
// </code></pre>

禁用高亮

import { compile, treeSitter } from "@unifast/node";

const result = compile(md, {
  plugins: [treeSitter({ engine: "none" })],
});

console.log(result.output);
// Code blocks are rendered without syntax highlighting