Markdown to HTML Converter

A simple and efficient npm package that converts Markdown content into HTML.

Table of Contents

• Installation
• Usage
• API
• Examples
• Contributing
• License

Installation

To install this package, run:

npm install markdown-parser-html

Usage

Basic Usage

import { parseMarkdownToHTML } from 'markdown-parser-html';

const markdown = `# Hello World
This is a **Markdown** document.`;

const html = parseMarkdownToHTML(markdown);

console.log(html);

Get a Dom Tree

You can also use this package from the command line:

import { getDomTreeFromMarkdown } from 'markdown-parser-html';

const markdown = `# Hello World
This is a **Markdown** document.`;

const html = getDomTreeFromMarkdown(markdown);

console.log(html);

API

parseMarkdownToHTML(markdown)

Converts the given Markdown string to HTML.

Parameters

• markdown (string): The Markdown content to convert.

Returns

• (string): The resulting HTML string.

getDomTreeFromMarkdown(markdown)

Converts the given Markdown string to List of Element.

Parameters

• markdown (string): The Markdown content to convert.

Returns

• (DOMTree): The resulting List of Nodes.
• Formatted like

{
  tag: string; // div, p, TEXT<for text only>
  tagType: "OPEN" | "CLOSE" | "SELF_CLOSE" | "TEXT"; // OPEN, CLOSE, TEXT
  attributes: Record<string, string>;
  content: string | null; // For Text Node only
  children: DOMTree[] // List of same nodes
}

Contributing

We welcome contributions! Please read our CONTRIBUTING.md for guidelines on how to contribute to this project.

License

This project is licensed under the MIT License. See the LICENSE file for details.