aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorLibravatar Titus Wormer <tituswormer@gmail.com>2022-10-11 15:36:06 +0200
committerLibravatar Titus Wormer <tituswormer@gmail.com>2022-10-11 15:36:06 +0200
commit070b3efeeebf34fbc435ffc7fea2bad95689664a (patch)
tree6bf5160810d780338cfd3cc3ddd34a6f0985d7c4
parent1d8e2b373b5e347a89f05e36c73b04487e04bead (diff)
downloadmarkdown-rs-070b3efeeebf34fbc435ffc7fea2bad95689664a.tar.gz
markdown-rs-070b3efeeebf34fbc435ffc7fea2bad95689664a.tar.bz2
markdown-rs-070b3efeeebf34fbc435ffc7fea2bad95689664a.zip
Refactor some prose
-rw-r--r--readme.md17
1 files changed, 10 insertions, 7 deletions
diff --git a/readme.md b/readme.md
index e5d6fcb..8bbbbe2 100644
--- a/readme.md
+++ b/readme.md
@@ -119,7 +119,7 @@ Yields:
</ul>
```
-Syntax tree:
+Syntax tree ([mdast][]):
```rs
extern crate micromark;
@@ -145,14 +145,15 @@ Root { children: [Heading { children: [Text { value: "Hey, ", position: Some(1:3
`micromark` exposes
[`micromark`](https://wooorm.com/micromark-rs/micromark/fn.micromark.html),
-[`micromark_with_options`](https://wooorm.com/micromark-rs/micromark/fn.micromark_with_options.html), and
-[`micromark_to_mdast`](https://wooorm.com/micromark-rs/micromark/fn.micromark_to_mdast.html), and
-[`Options`](https://wooorm.com/micromark-rs/micromark/struct.Options.html).
-See [crate docs][docs] for more info.
+[`micromark_with_options`](https://wooorm.com/micromark-rs/micromark/fn.micromark_with_options.html),
+[`micromark_to_mdast`](https://wooorm.com/micromark-rs/micromark/fn.micromark_to_mdast.html),
+[`Options`](https://wooorm.com/micromark-rs/micromark/struct.Options.html),
+and a few other structs and enums.
+See the [crate docs][docs] for more info.
## Extensions
-micromark supports extensions.
+micromark supports extensions to `CommonMark`.
These extensions are maintained in this project.
They are not enabled by default but can be turned on with options.
@@ -354,6 +355,8 @@ The files in `src/` are as follows:
— turns events into a syntax tree
- `tokenizer.rs`
— glue the states of the state machine together
+- `unist.rs`
+ — point and position, used in mdast
### Comparison
@@ -363,7 +366,7 @@ The files in `src/` are as follows:
### Test
-micromark is tested with the \~650 CommonMark tests and more than 1.7k extra
+micromark is tested with the \~650 CommonMark tests and more than 1k extra
tests confirmed with CM reference parsers.
Then there’s even more tests for GFM and other extensions.
These tests reach all branches in the code, which means that this project has