Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/web-infra-dev/mdx-rs
Rust MDX compilation binding for Rspress
https://github.com/web-infra-dev/mdx-rs
hacktoberfest markdown mdx
Last synced: 4 days ago
JSON representation
Rust MDX compilation binding for Rspress
- Host: GitHub
- URL: https://github.com/web-infra-dev/mdx-rs
- Owner: web-infra-dev
- License: mit
- Created: 2023-03-22T08:40:18.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-13T07:48:33.000Z (13 days ago)
- Last Synced: 2025-01-14T07:07:49.818Z (12 days ago)
- Topics: hacktoberfest, markdown, mdx
- Language: Rust
- Homepage:
- Size: 413 KB
- Stars: 97
- Watchers: 10
- Forks: 14
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# @rspress/mdx-rs
This is a Node.js binding for MDX compilation of [Rspress](https://rspress.dev) which is a modern documentation tool based on [Rspack](https://www.rspack.org/).
It can be 10x+ faster than compiler in pure JavaScript version.The [benchmark](./benches/index.mjs) result of `@rspress/mdx-rs` vs `@mdx-js/mdx` is as follows:
| Tool | Time Spend |
| --------------- | ---------- |
| @rspress/mdx-rs | 977 ms |
| @mdx-js/mdx | 21300 ms |
We forked [mdxjs-rs](https://github.com/wooorm/mdxjs-rs), the Rust version of mdx compiler and customize it for Rspress, adding the following features:
| Crate | Description |
| ----------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [mdx_rs_binding](./crates/binding) | 🔥 Add Node.js binding so that we can use it in Node.js. |
| [mdx_plugin_container](./crates/plugin_container) | Implement container grammar like `:::tip` in [@rspress/plugin-container-syntax](https://github.com/web-infra-dev/rspress/blob/main/packages/plugin-container-syntax/src/remarkPlugin.ts). |
| [mdx_plugin_toc](./crates/plugin_toc) | Generate table of contents. |
| [mdx_plugin_frontmatter](./crates/plugin_frontmatter) | Parse frontmatter and export it in the esm module. |
| [mdx_plugin_external_link](./crates/plugin_external_link) | Add `target="_blank"` and `rel="noopener noreferrer"` to external link. |
| [mdx_plugin_header_anchor](./crates/plugin_header_anchor) | Add anchor for every header. |
| [mdx_plugin_normalize_link](./crates/plugin_normalize_link) | Normalize link to complete url base on current filepath. |
| [mdx_plugin_html](./crates/plugin_html) | Serialize hast to html string |
| [slugger](./crates/slugger) | Generate slug for header, port from [github-slugger](https://github.com/Flet/github-slugger). |
## Install
```bash
# npm
npm install @rspress/mdx-rs
# yarn
yarn add @rspress/mdx-rs
# pnpm
pnpm install @rspress/mdx-rs
```
## Usage
```js
import { compile } from "@rspress/mdx-rs";
async function main() {
const value = `
# Hello World
This is a demo of @rspress/mdx-rs
`;
const result = await compile({
// The mdx content
value,
// File path of the mdx file, the compiler will determine the different syntax(md/mdx) based on the file extension
filepath: "xxx.mdx",
// Whether to enable development mode, default is false
development: true,
// Current working directory, can be empty string
root: "",
});
console.log(result);
}
```
Of course, you can also the `compileSync` function to compile mdx synchronously, which is not recommended because it will block the event loop and slow down the compile process.
```js
import { compileSync } from "@rspress/mdx-rs";
function main() {
const value = `
# Hello World
This is a demo of @rspress/mdx-rs
`;
const result = compileSync({
// The mdx content
value,
// File path of the mdx file, can be empty string
filepath: "",
// Whether to enable development mode, default is false
development: true,
// Current working directory, can be empty string
root: "",
});
console.log(result);
}
```
## Credits
Thanks to [mdxjs-rs](https://github.com/wooorm/mdxjs-rs), the awesome Rust library authored by [wooorm](https://github.com/wooorm).
Also, thanks to [napi-rs](https://github.com/napi-rs/napi-rs), authored by [Brooooooklyn](https://github.com/Brooooooklyn), which is a great solution to help us build Node.js binding for Rust.