comfit-core 0.1.0

Comfit highlighting engine, theme model, and renderers
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
44
45

# comfit-core

Comfit highlighting engine, theme model, and renderers.

[![crates.io](https://img.shields.io/crates/v/comfit-core.svg)](https://crates.io/crates/comfit-core)
[![docs](https://img.shields.io/docsrs/comfit-core?label=docs)](https://docs.rs/comfit-core)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

[Documentation](https://comfit.pinanek.me) ยท [crates.io](https://crates.io/crates/comfit-core)

## Installation

```sh
cargo add comfit-core --features render-html
```

## Usage

```rust
use comfit_core::{Highlighted, Line, RenderHtmlConfig, Token};

fn main() {
    let highlighted = Highlighted {
        lines: vec![Line {
            number: 1,
            highlighted: false,
            tokens: vec![Token {
                text: "fn",
                highlight: Some("keyword.function"),
                rainbow: None,
            }],
        }],
    };
    println!(
        "{}",
        highlighted.render_html_classes(&RenderHtmlConfig::default())
    );
}
```

See the [API reference](https://docs.rs/comfit-core/latest/comfit_core/) for backend integration and the [HTML guide](https://comfit.pinanek.me/docs/guides/html) for rendering options.

## License

Licensed under the [MIT License](LICENSE).