Skip to content

Commit a7a1d6f

Browse files
committed
Add links to mdxjs-rs
1 parent d7b7d2c commit a7a1d6f

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

readme.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ to markdown such as MDX, math, and frontmatter.
5151
This Rust crate has a sibling project in JavaScript: [`micromark`][micromark]
5252
(and [`mdast-util-from-markdown`][mdast-util-from-markdown] for the AST).
5353

54+
P.S. if you want to *compile* MDX, use [`mdxjs-rs`][mdxjs-rs].
55+
5456
## Questions
5557

5658
* to learn markdown, see this [cheatsheet and tutorial][cheat]
@@ -68,6 +70,7 @@ This Rust crate has a sibling project in JavaScript: [`micromark`][micromark]
6870
* [Overview](#overview)
6971
* [File structure](#file-structure)
7072
* [Test](#test)
73+
* [Related](#related)
7174
* [Version](#version)
7275
* [Security](#security)
7376
* [Contribute](#contribute)
@@ -273,6 +276,13 @@ The following bash scripts are useful when working on this project:
273276
cargo hfuzz run markdown_honggfuzz
274277
```
275278

279+
### Related
280+
281+
* [`micromark`][micromark]
282+
— same as `markdown-rs` but in JavaScript
283+
* [`mdxjs-rs`][mdxjs-rs]
284+
— wraps `markdown-rs` to *compile* MDX to JavaScript
285+
276286
### Version
277287

278288
`markdown-rs` follows [SemVer](https://semver.org).
@@ -378,6 +388,8 @@ Special thanks go out to:
378388

379389
[micromark]: https://github.com/micromark/micromark
380390

391+
[mdxjs-rs]: https://github.com/wooorm/mdxjs-rs
392+
381393
[mdast-util-from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown
382394

383395
[vercel]: https://vercel.com

0 commit comments

Comments
 (0)