11 releases

0.4.1 Dec 11, 2022
0.4.0 Dec 11, 2022
0.3.1 Jun 6, 2022
0.3.0 Dec 23, 2021
0.1.2 Dec 14, 2021

#2 in #cmark


Used in 2 crates (via blades)

GPL-3.0-or-later

21KB
422 lines

cmark syntax highlighting

Crates.io status Docs

This crate provides a preprocessor for pulldown_cmark events that implements syntax highlighting. It is based on the work of Maciej Hirsz for the Ramhorns templating engine.

Supported languages

  • Rust
  • JavaScript
  • sh shell
  • TOML

Files defining language syntax are located in src/languages directory. The syntax is defined using regexes, which the Logos procedural macro turns into a lexer at the compile time. PRs implementing new languages are very welcome!

Features

With latex2mathml feature enabled, blocks denoted by math containing LaTeX formulas are rendered into MathML in block mode and analogously for inline code delimited by $ at the start and the end in inline mode.

Use

This preprocessor can be used as a callback for the Ramhorns templating engine.

use ramhorns::encoding::Encoder;

pub fn encode<E: Encoder>(source: &str, encoder: &mut E) -> Result<(), E::Error> {
    let parser = pulldown_cmark::Parser::new(source);
    let processed = cmark_syntax::SyntaxPreprocessor::new(parser);
    encoder.write_html(processed)
}

Dependencies

~3MB
~25K SLoC