Markdown Generator

A simple and flexible JavaScript class to create Markdown content programmatically.
Supports headings, text styles (bold, italic, bold-italic, underline), code blocks, quotes, links, images, and checklists.

Features

• Create headings (H1, H2, H3) easily
• Format text as italic, bold, bold italic, or underline
• Insert fenced code blocks with optional language specification
• Add blockquotes
• Add links and images with alt text
• Create task/checklists with checkboxes

Installation

npm install easy-markdown

Usage

const Markdown = require('easy-markdown');
const md = new Markdown();

md.setHeading(1, "Markdown Generator");
md.setHeadingDescription(1, "Generate Markdown content programmatically.");

md.italic("This text is italic");
md.bold("This text is bold");
md.boldItalic("This text is bold and italic");
md.__bold("This text is underlined bold");

md.setCodeBlock('console.log("Hello World");', "js");

md.setQuote("This is a blockquote.");

md.setLink("Youtube", "https://youtube.com");

md.setImage("Youtube logo", "https://upload.wikimedia.org/wikipedia/commons/thumb/0/09/YouTube_full-color_icon_%282017%29.svg/1024px-YouTube_full-color_icon_%282017%29.svg.png");

md.addChecklistItem("Write README", true);
md.addChecklistItem("Publish package", false);

console.log(md.get("heading1"));
console.log(md.renderChecklist());

Docs

• setHeading(number, text) — Set heading level 1, 2, or 3
• setHeadingDescription(number, text) — Add description text below heading
• italic(text) — Italicize text
• bold(text) — Bold text
• boldItalic(text) — Bold and italic text
• __bold(text) — Underlined bold text
• setCodeBlock(text, language) — Add fenced code block
• setQuote(text) — Add blockquote
• setLink(label, url) — Add hyperlink
• setImage(alt, url) — Add image with alt text
• addChecklistItem(text, checked) — Add checklist item with checkbox
• renderChecklist() — Render all checklist items as Markdown