@syncfusion/ej2-markdown-converter

v32.1.22

Published

11 hours ago

Essential JS 2 Markdown converter

0High
0Medium
0Low

syncfusionorg

essentialjs2

syncfusion-javascript

ej2 syncfusion package-name

JavaScript Markdown Converter

The JavaScript Markdown Converter is a lightweight, stateless, and efficient utility for converting Markdown content to HTML. It is designed to work seamlessly with Syncfusion EJ2 components, including the Markdown Editor, and other applications that require reliable Markdown processing.

⚡️ Quick Start

The JavaScript Markdown Converter is easy to set up. Simply install the package, import the module, and use the provided static API to convert Markdown into HTML.

Installation

To install the Markdown Converter via npm, run the following command:

npm install @syncfusion/ej2-markdown-converter --save

Import the Module

Import the Markdown Converter module into your application:

import { MarkdownConverter } from '@syncfusion/ej2-markdown-converter';

Convert Markdown to HTML

Use the static method parseToHtml() to convert Markdown to HTML:

// Convert Markdown to HTML
const markdown = '# Hello World\nThis is **Markdown** text.';
const html = MarkdownConverter.parseToHtml(markdown) as string;
console.log('HTML Output:', html);

Run the Application

Open your project in a browser and verify the converted HTML output in the console. 🚀

🛠️ Supported frameworks

Markdown Converter control is also offered in following list of frameworks.

| Angular | React | Vue | ASP.NET Core | ASP.NET MVC | | :-----: | :-----: | :-----: | :-----: | :-----: |

✨ Key features

Markdown to HTML Conversion – Convert Markdown content to HTML with high accuracy.
Preserves Formatting – Maintains headings, lists, links, images, tables, and inline styles during conversion.
Configurable Options – Customize conversion behavior with the following options:
- async – Enables asynchronous conversion for large content processing.
- gfm – Support GitHub Flavored Markdown.
- lineBreak – Converts single line breaks into <br> elements..
- silence – Suppresses errors and skips invalid Markdown instead of throwing exceptions.
Example:
```
// Convert Markdown to HTML
const markdown = '# Hello World\nThis is **Markdown** text.';
const html: string | Promise<string> = MarkdownConverter.parseToHtml(markdown, {
    gfm: true,
    async: true,
    lineBreak: true,
    silent: true
}) as string;
console.log('HTML Output:', html);
```
Modular Architecture – Easily integrate with Rich Text Editor or use as a standalone utility.
Performance Optimized – Fast and reliable conversion for large content blocks.
Cross-Platform Support – Works in modern browsers and supports mobile-friendly applications.

🤝 Support

Product support is available through the following mediums.

Support ticket - Guaranteed Response in 24 hours | Unlimited tickets | Holiday support
Community forum
GitHub issues
Request feature or report bug
Live chat

🔄 Change log

Check the changelog here. Get minor improvements and bug fixes every week to stay up to date with frequent updates.

⚖️ License and copyright

This is a commercial product and requires a paid license for possession or use. Syncfusion® licensed software, including this component, is subject to the terms and conditions of Syncfusion® EULA. To acquire a license for 80+ JavaScript UI controls, you can purchase or start a free 30-day trial.

A free community license is also available for companies and individuals whose organizations have less than $1 million USD in annual gross revenue and five or fewer developers.

See LICENSE FILE for more info.