https://github.com/aliezzahn/rs-markdown-parser
A Node.js module for converting Markdown files to HTML using Rust
https://github.com/aliezzahn/rs-markdown-parser
cargo converter html loader markdown nodejs npm npm-package parser rust
Last synced: about 1 month ago
JSON representation
A Node.js module for converting Markdown files to HTML using Rust
- Host: GitHub
- URL: https://github.com/aliezzahn/rs-markdown-parser
- Owner: aliezzahn
- License: mit
- Created: 2025-05-03T13:13:42.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-05-03T19:52:06.000Z (9 months ago)
- Last Synced: 2025-09-17T06:27:30.343Z (5 months ago)
- Topics: cargo, converter, html, loader, markdown, nodejs, npm, npm-package, parser, rust
- Language: Rust
- Homepage: https://www.npmjs.com/package/rs-markdown-parser
- Size: 18.6 KB
- Stars: 10
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🚀 rs-markdown-parser
A blazing-fast Node.js module for converting Markdown to HTML — powered by Rust’s [`pulldown-cmark`](https://docs.rs/pulldown-cmark) and [Neon](https://neon-bindings.com/) for seamless Node integration.
---
## ✨ Features
- ⚡ **Ultra-fast conversion** using Rust’s performance and `pulldown-cmark`.
- 🧩 **Optional GitHub Flavored Markdown (GFM)** support — tables, footnotes, strikethrough, task lists, and heading attributes.
- 📦 **ES module export** — easily import HTML in your frontend projects.
- 🛡️ **TypeScript ready** — includes full type definitions.
---
## 📦 Installation
```bash
npm install rs-markdown-parser
````
> 💡 *Note: To modify or rebuild the native module, follow the build instructions below.*
---
## 🛠️ Building the Module
If you're editing the Rust source or cross-compiling, use one of the following scripts:
| Mode | Command | Notes |
| ----------- | --------------- | -------------------------------- |
| Debug | `npm run debug` | Fast builds for development |
| Release | `npm run build` | Optimized builds for production |
| Cross-build | `npm run cross` | Build for other target platforms |
The build will generate a native Node.js addon (`index.node`).
---
## 🚀 Usage
### Importing the Module
#### JavaScript
```js
const { processMarkdown } = require("rs-markdown-parser");
const { join } = require("path");
const filePath = join(__dirname, "test.md");
const result = processMarkdown(filePath, false);
console.log(result); // => export default ``;
```
#### TypeScript
```ts
import { processMarkdown } from "rs-markdown-parser";
import { join } from "path";
const filePath: string = join(__dirname, "test.md");
const result: string = processMarkdown(filePath, false);
console.log(result); // => export default ``;
```
---
## 🧪 Example
### Sample Markdown (`test.md`)
```markdown
# Hello, World!
This is a **Markdown** file.
- Item 1
- Item 2
# Product Comparison
| Product | Price | Features | In Stock |
|--------------|---------|----------------------------|----------|
| Phone A | $299 | 64GB, 12MP Camera, 4G LTE | Yes |
| Phone B | $399 | 128GB, 48MP Camera, 5G | No |
| Phone C | $499 | 256GB, 108MP Camera, 5G | Yes |
```
### Output (ES Module String)
---
## 🧬 GitHub Flavored Markdown (GFM)
Enable extended Markdown features with the `gfm` flag:
```js
const result = processMarkdown(filePath, true);
```
Supported GFM features:
* ✔️ Task lists
* 📑 Footnotes
* 🔡 Strikethrough (`~~text~~`)
* 🧮 Tables
* 🏷️ Heading attributes (`## Title {#id}`)
---
## 🔷 TypeScript Support
This module includes `index.d.ts` for full TypeScript support. To use:
1. Ensure TypeScript is installed:
```bash
npm install --save-dev typescript
```
2. Import the module as usual. Type definitions are automatically applied.
---
## 🧪 Development & Testing
### Run tests:
```bash
npm run test
```
### Rebuild after source changes:
* Edit Rust: `src/lib.rs`
* Edit Types: `index.d.ts`
Then:
```bash
npm run debug
# or
npm run build
```
---
## 📄 License
MIT License — see [LICENSE](./LICENSE).
---
## 🤝 Contributing
Contributions welcome! Please open an issue or PR:
👉 [GitHub Repository](https://github.com/aliezzahn/rs-markdown-parser)
---
## 🐞 Issues & Support
Found a bug or need a feature?
📬 Report it on [GitHub Issues](https://github.com/aliezzahn/rs-markdown-parser/issues)
## 👥 Contributors
Thanks to these awesome people for their work on this project:
