mdbook-treesitter 1.1.0

mdbook-treesitter is an mdBook preprocessor for html adding tree-sitter highlighting support.
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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

# mdbook-treesitter

mdbook-treesitter is an [mdBook](https://github.com/rust-lang-nursery/mdBook) preprocessor for html adding [tree-sitter](https://tree-sitter.github.io/tree-sitter/) highlighting support.

It simply translates the tree-sitter highlighting into highlightjs one.

## Installation

Install the preprocessor:

```shell
cargo install mdbook-treesitter
```

### Configure mdBook

Add this in your `book.toml`:

```toml
[preprocessor.treesitter]
command = "mdbook-treesitter"
languages = ["javascript"]
```

## Usage

Use usual codeblocks like that:

````markdown
```javascript
console.log(this.a + b + "c" + 4);
```
````

Wait, you need to add related tree-sitter files:

- Create a folder `treesitter` in the root of your mdBook project
- Then, add your `language_name.so` in the created folder
  - Note: This also works on Windows systems, copy the tree-sitter `parser.dll` as `language_name.so`, even if it is not a `*.so` file.
- Next, create a folder `language_name` in the `tree-sitter` folder
- Finally, add in it your scm files

Example for javascript:

```
- My awesome mdBook/
    - book.toml
    - book/
    - src/
    - treesitter/
        - javascript.so
        - javascript/
            - highlights.scm
            - injections.scm
            - locals.scm
```


 
 

🧃