syntect()

Crée un plugin syntect qui active la coloration syntaxique native Rust pour les blocs de code clôturés. Propulsé par les définitions de syntaxe Sublime Text avec la prise en charge de plus de 100 langages.

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

Signature

function syntect(options?: SyntectPluginOptions): UnifastPlugin

Paramètres

options?

Configuration du moteur de coloration

PropriétéTypeDéfautDescription
engine"none" | "syntect""syntect"“syntect” utilise le coloriseur syntect ; “none” désactive la coloration

Utilisation

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

Exemples

Activer la coloration syntaxique

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>

Désactiver la coloration

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