syntect()

Create a syntect plugin that enables Rust-native syntax highlighting for fenced code blocks. Powered by Sublime Text syntax definitions with support for 100+ languages.

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

Signature

function syntect(options?: SyntectPluginOptions): UnifastPlugin

Parameters

options?

Highlighting engine configuration

PropertyTypeDefaultDescription
engine"none" | "syntect""syntect"“syntect” uses the syntect highlighter; “none” disables highlighting

Usage

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

const md = `
# Code Example

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

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

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

Examples

Enable syntax highlighting

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

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

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

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

Disable highlighting

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

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

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