mdbook-ts 0.2.6

An mdBook preprocessor that uses tree-sitter to extract code snippets from source files
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

# Introduction

This book demonstrates the `mdbook-treesitter` preprocessor, which lets you
embed live code snippets extracted directly from source files using
[tree-sitter](https://tree-sitter.github.io) queries.

## How it works

Add a directive to any chapter:

\{{ #treesitter ../examples/geometry.rs }}

\{{ #treesitter ../examples/geometry.rs#doc_comment?name=Point }}

\{{ #treesitter ../examples/geometry.rs#struct?name=Rectangle }}

The preprocessor reads the referenced file, runs the named query (if any),
and replaces the directive with the extracted text.  Wrap the directive in a
fenced code block to get syntax-highlighted output:

````markdown
```rust
\{{ #treesitter ../examples/geometry.rs#doc_comment?name=Point }}
```
````