Quick Start Guide

npm install marked

import { marked } from "marked";

const markdown = '# Hello World\n\nThis is **markdown**.';
const html = marked.parse(markdown);

console.log(html);
// Output: <h1>Hello World</h1>\n<p>This is <strong>markdown</strong>.</p>\n

import { marked } from "marked";

const inline = marked.parseInline('This is **bold** text');
console.log(inline);
// Output: This is <strong>bold</strong> text

import { marked } from "marked";

import {
  marked,           // Main parse function
  parse,            // Alias for marked
  parseInline,      // Parse inline markdown only
  Lexer,            // Tokenizer class
  Parser,           // Parser class
  Renderer,         // HTML renderer class
  Tokenizer,        // Low-level tokenizer class
  Hooks,            // Processing hooks class
  Marked            // Instance class for isolated configs
} from "marked";

const { marked } = require("marked");

<script src="https://cdn.jsdelivr.net/npm/marked/lib/marked.umd.js"></script>
<script>
  const html = marked.parse('# Hello');
</script>

import { marked, MarkedOptions, Token, Tokens } from "marked";

const options: MarkedOptions = {
  gfm: true,
  breaks: true
};

marked.setOptions(options);

import { marked } from "marked";

marked.setOptions({
  gfm: true,        // Enable GitHub Flavored Markdown
  breaks: true,     // Convert \n to <br>
  pedantic: false,  // Don't fix markdown bugs
  silent: false     // Throw on errors
});

const html = marked.parse(markdown);

import { marked } from "marked";

// Override global options for specific parse
const html = marked.parse(markdown, {
  breaks: false,  // Override global setting
  gfm: true
});

import { Marked } from "marked";

// Create instance for GitHub Flavored Markdown
const gfmMarked = new Marked({
  gfm: true,
  breaks: true
});

// Create instance for strict CommonMark
const strictMarked = new Marked({
  gfm: false,
  pedantic: false
});

// Each instance has independent configuration
const html1 = gfmMarked.parse('Line 1\nLine 2'); // Has <br>
const html2 = strictMarked.parse('Line 1\nLine 2'); // No <br>

import { marked } from "marked";
import DOMPurify from "dompurify";

// UNSAFE - vulnerable to XSS
const unsafeHtml = marked.parse(userInput);

// SAFE - sanitized output
const dirty = marked.parse(userInput);
const clean = DOMPurify.sanitize(dirty);

// Use clean HTML in your application
document.getElementById('content').innerHTML = clean;

import { marked } from "marked";

try {
  const html = marked.parse(malformedMarkdown);
} catch (err) {
  console.error('Parse error:', err.message);
}

import { marked } from "marked";

marked.setOptions({ silent: true });
const html = marked.parse(malformedMarkdown);
// Returns: <p>An error occurred:</p><pre>Error message</pre>

import { marked } from "marked";

marked.setOptions({
  gfm: true,
  breaks: true
});

const html = marked.parse(`
# Title

Line 1
Line 2

| A | B |
|---|---|
| 1 | 2 |

~~strikethrough~~

- [ ] Task 1
- [x] Task 2
`);

import { marked } from "marked";

marked.setOptions({
  gfm: false,
  breaks: false,
  pedantic: false
});

import { marked } from "marked";

marked.setOptions({
  pedantic: true,
  gfm: false
});

import { marked } from "marked";

// Enable async mode
marked.setOptions({ async: true });

const html = await marked.parse('# Async Markdown');

// Or pass async option directly
const html2 = await marked.parse('# Title', { async: true });

# Install globally
npm install -g marked

# Parse file
marked input.md -o output.html

# Parse with options
marked input.md --gfm --breaks

# From stdin
echo "# Hello" | marked

# Multiple files
marked file1.md file2.md --output-dir dist/

import { marked } from "marked";
import fs from "fs";

const markdown = fs.readFileSync('README.md', 'utf-8');
const html = marked.parse(markdown, { gfm: true });
fs.writeFileSync('README.html', html);

import { marked } from "marked";
import DOMPurify from "dompurify";

function renderComment(userComment) {
  const html = marked.parse(userComment);
  return DOMPurify.sanitize(html);
}

import { marked } from "marked";

marked.setOptions({
  gfm: true,
  breaks: false
});

const postHtml = marked.parse(blogPost);

import { marked } from "marked";

const tooltipHtml = marked.parseInline('This is **important**');
// Use parseInline for short content without <p> wrapper

marked.parse('');              // Returns: ''
marked.parse(null);            // Throws: TypeError
marked.parse(undefined);       // Throws: TypeError

// Very large inputs (>10MB) may have performance implications
const largeMarkdown = '...'; // 10MB+

console.time('parse');
const html = marked.parse(largeMarkdown);
console.timeEnd('parse');
// Typical: < 1 second for 10MB