rs-markdown-parser

A Node.js module for converting Markdown files to HTML using Rust, powered by the pulldown-cmark library and Neon bindings.

Features

• Fast Markdown to HTML conversion using Rust's pulldown-cmark.
• Optional GitHub Flavored Markdown (GFM) support for tables, footnotes, strikethrough, task lists, and heading attributes.
• Exports HTML as an ES module for easy integration.
• TypeScript support with type definitions.

Installation

1. Install the package:

   npm install rs-markdown-parser

2. Build the module (if modifying source):

   • For development (debug build):

     npm run debug

   • For production (release build):

     npm run build

   • For cross-compilation (if targeting different platforms):

     npm run cross

   The build process compiles the Rust code into a native Node.js module (index.node).

Usage

The module exports a single function, processMarkdown, which converts a Markdown file to HTML and returns it as an ES module string.

Parameters

• filePath (string): The file path to the Markdown file (e.g., "./test.md"). Must be a valid path to an existing file.
• gfm (boolean): Enables GitHub Flavored Markdown features. Set to true to support tables, footnotes, strikethrough, task lists, and heading attributes; false for standard Markdown.

JavaScript Example

const { processMarkdown } = require("rs-markdown-parser");
const { join } = require("path");

const filePath = join(__dirname, "./test.md");
const result = processMarkdown(filePath, false);

console.log(result); // Outputs: export default `<html_content>`;

TypeScript Example

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); // Outputs: export default `<html_content>`;

Example Markdown File (test.md)

# Hello, World!

This is a **Markdown** file.

- Item 1
- Item 2

Output

export default `<h1>Hello, World!</h1>\n<p>This is a <strong>Markdown</strong> file.</p>\n<ul>\n<li>Item 1</li>\n<li>Item 2</li>\n</ul>`;

Using with GFM

To enable GitHub Flavored Markdown features:

const result = processMarkdown(filePath, true);

This enables support for:

• Tables
• Footnotes
• Strikethrough
• Task lists
• Heading attributes

TypeScript Support

This module includes TypeScript type definitions in index.d.ts. To use with TypeScript:

1. Ensure TypeScript is installed:

   npm install -g typescript

2. Include the module in your TypeScript project:

   npm install rs-markdown-parser

3. The type definitions are automatically picked up from index.d.ts when you import the module.

Development

• Run tests:

  npm run test

• Rebuild after changes: Modify the Rust code in src/lib.rs or TypeScript definitions in index.d.ts and run npm run debug or npm run build.

License

MIT License. See LICENSE for details.

Contributing

Contributions are welcome! Please open an issue or submit a pull request on GitHub.

Issues

Report bugs or request features on the GitHub Issues page.