Parsing API

Functions and types for converting markdown to HTML.

markdown()

Convert markdown text to safe HTML.

Signature:

function markdown(
  input: string,
  options?: MarkdownOptions
): string

Parameters:

Returns: string — HTML output with all markdown converted and dangerous content removed.

Example:

import { markdown } from '@motioneffector/markdown'

// Basic usage
const html = markdown('# Hello **world**')
// => '<h1>Hello <strong>world</strong></h1>'

// With options
const html = markdown('[Link](url)', {
  linkTarget: '_blank',
  gfm: true,
  sanitize: true,
  breaks: false
})

Types

MarkdownOptions

Configuration options for the markdown() function.

interface MarkdownOptions {
  gfm?: boolean
  sanitize?: boolean
  breaks?: boolean
  linkTarget?: string
}

Option Details

gfm

Enables GitHub Flavored Markdown extensions.

import { markdown } from '@motioneffector/markdown'

// Enabled (default)
markdown('| A | B |\n|---|---|\n| 1 | 2 |')
// => '<table>...</table>'

// Disabled
markdown('| A | B |\n|---|---|\n| 1 | 2 |', { gfm: false })
// => '<p>| A | B |...</p>'

GFM features:

• Tables with alignment
• Strikethrough (~~text~~)
• Task lists (- [x] done)
• Extended autolinks (bare URLs)

sanitize

Controls URL sanitization. Dangerous tags are always removed regardless of this setting.

import { markdown } from '@motioneffector/markdown'

// Enabled (default)
markdown('[Click](javascript:alert(1))')
// => '<p>Click</p>' (dangerous URL removed)

// Disabled (for trusted content only)
markdown('<div class="custom">text</div>', { sanitize: false })
// => '<p><div class="custom">text</div></p>'

Even with sanitize: false:

• <script>, <style>, <iframe>, <object>, <embed> are always removed
• Event handlers (onclick, etc.) are always removed

breaks

Controls how single line breaks are handled.

import { markdown } from '@motioneffector/markdown'

// Disabled (default) - CommonMark behavior
markdown('Line 1\nLine 2')
// => '<p>Line 1\nLine 2</p>' (soft break)

// Enabled - every newline becomes <br>
markdown('Line 1\nLine 2', { breaks: true })
// => '<p>Line 1<br />\nLine 2</p>'

Without breaks: true, use two spaces + newline or backslash + newline for hard breaks.

linkTarget

Adds a target attribute to all links.

import { markdown } from '@motioneffector/markdown'

markdown('[Link](https://example.com)', { linkTarget: '_blank' })
// => '<p><a href="https://example.com" target="_blank">Link</a></p>'

Common values:

• '_blank' - Open in new tab
• '_self' - Open in same frame
• '_parent' - Open in parent frame
• '_top' - Open in full window

Supported Markdown

Block Elements

Inline Elements