oak-rst 0.0.11

High-performance incremental reStructuredText parser for the oak ecosystem.
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

# oak-rst


High-performance incremental reStructuredText parser for the oak ecosystem.

## Features


- Incremental parsing for efficient editing
- Support for core reStructuredText syntax
- Extensible architecture
- Integration with the oak ecosystem

## Usage


```rust
use oak_rst::{RstLanguage, RstParser};

let language = RstLanguage::default();
let parser = RstParser::new(&language);

// Parse reStructuredText content
let content = "Hello World\n==========\n\nThis is a paragraph.";
let parse_result = parser.parse(content, &[], &mut ());

// Access the parsed AST
let root = parse_result.unwrap();
```

## Supported Syntax


- Headings
- Paragraphs
- Lists (bullet points)
- Tables
- Code blocks
- Comments
- Directives
- Emphasis and strong text
- Literal text
- Links and references

## Configuration


The `RstLanguage` struct allows you to configure various aspects of the parser:

- `allow_directives`: Enable/disable directives
- `allow_substitutions`: Enable/disable substitutions
- `allow_roles`: Enable/disable roles
- `allow_footnotes`: Enable/disable footnotes
- `allow_citations`: Enable/disable citations
- `allow_admonitions`: Enable/disable admonitions

## License


This project is licensed under the MIT License.