From a7a1d6f97afca5b06594b1bf3f7e05730926171f Mon Sep 17 00:00:00 2001 From: Titus Wormer Date: Thu, 11 May 2023 09:48:51 +0200 Subject: Add links to `mdxjs-rs` --- readme.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) 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 -- cgit