aboutsummaryrefslogtreecommitdiffstats
path: root/readme.md
diff options
context:
space:
mode:
authorLibravatar Titus Wormer <tituswormer@gmail.com>2023-05-11 09:48:51 +0200
committerLibravatar Titus Wormer <tituswormer@gmail.com>2023-05-11 09:48:51 +0200
commita7a1d6f97afca5b06594b1bf3f7e05730926171f (patch)
tree97bc546f402d87f6a8477c3fe046ead5907ce1eb /readme.md
parentd7b7d2ce998dd870da799ab2adfe92df386fb516 (diff)
downloadmarkdown-rs-a7a1d6f97afca5b06594b1bf3f7e05730926171f.tar.gz
markdown-rs-a7a1d6f97afca5b06594b1bf3f7e05730926171f.tar.bz2
markdown-rs-a7a1d6f97afca5b06594b1bf3f7e05730926171f.zip
Add links to `mdxjs-rs`
Diffstat (limited to 'readme.md')
-rw-r--r--readme.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/readme.md b/readme.md
index 401b96b..b16786d 100644
--- a/readme.md
+++ b/readme.md
@@ -51,6 +51,8 @@ to markdown such as MDX, math, and frontmatter.
This Rust crate has a sibling project in JavaScript: [`micromark`][micromark]
(and [`mdast-util-from-markdown`][mdast-util-from-markdown] for the AST).
+P.S. if you want to *compile* MDX, use [`mdxjs-rs`][mdxjs-rs].
+
## Questions
* to learn markdown, see this [cheatsheet and tutorial][cheat]
@@ -68,6 +70,7 @@ This Rust crate has a sibling project in JavaScript: [`micromark`][micromark]
* [Overview](#overview)
* [File structure](#file-structure)
* [Test](#test)
+ * [Related](#related)
* [Version](#version)
* [Security](#security)
* [Contribute](#contribute)
@@ -273,6 +276,13 @@ The following bash scripts are useful when working on this project:
cargo hfuzz run markdown_honggfuzz
```
+### Related
+
+* [`micromark`][micromark]
+ — same as `markdown-rs` but in JavaScript
+* [`mdxjs-rs`][mdxjs-rs]
+ — wraps `markdown-rs` to *compile* MDX to JavaScript
+
### Version
`markdown-rs` follows [SemVer](https://semver.org).
@@ -378,6 +388,8 @@ Special thanks go out to:
[micromark]: https://github.com/micromark/micromark
+[mdxjs-rs]: https://github.com/wooorm/mdxjs-rs
+
[mdast-util-from-markdown]: https://github.com/syntax-tree/mdast-util-from-markdown
[vercel]: https://vercel.com