highlight-pulldown 0.2.2

Process pulldown-cmark events to apply syntax highlighting to code blocks
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

[![pipeline status](https://gitlab.com/eguiraud/highlight-pulldown/badges/main/pipeline.svg)](https://gitlab.com/eguiraud/highlight-pulldown/-/commits/main)
[![crates.io](https://img.shields.io/crates/v/highlight-pulldown.svg)](https://crates.io/crates/highlight-pulldown)

# Highlight Pulldown Code

A small library crate to apply syntax highlighting to markdown parsed with [pulldown-cmark](https://crates.io/crates/pulldown-cmark).

The implementation is based on the discussion at [pulldown-cmark#167](https://github.com/raphlinus/pulldown-cmark/issues/167).

## Usage

The crate exposes a single function, `highlight`.
It takes an iterator over pulldown-cmark events and returns a corresponding `Vec<pulldown_cmark::Event>` where
code blocks have been substituted by HTML blocks containing highlighted code.

```rust
use highlight_pulldown::highlight_with_theme;

let markdown = r#"
```rust
enum Hello {
    World,
    SyntaxHighlighting,
}
```"#;
let events = pulldown_cmark::Parser::new(markdown);

// apply a syntax highlighting pass to the pulldown_cmark events
let events = highlight_with_theme(events, "base16-ocean.dark").unwrap();

// emit HTML or further process the events as usual
let mut html = String::new();
pulldown_cmark::html::push_html(&mut html, events.into_iter());
```

For better efficiency, instead of invoking `highlight` or `highlight_with_theme` in a hot
loop consider creating a `PulldownHighlighter` object once and use it many times.

## Contributing

If you happen to use this package, any feedback is more than welcome.

Contributions in the form of issues or patches via the GitLab repo are even more appreciated.