@eryx/markdown Module

JSON

Summary

Classes

Markdown
config: types.MarkdownConfig
Markdown.new(config: MarkdownConfig) → Markdown
Markdown:parse(source: string) → types.DocumentBlockNode
Markdown:renderHtml(doc: types.DocumentBlockNode) → string

Functions

markdown.parse(source: string, config: MarkdownConfig) → types.DocumentBlockNode
markdown.toc(doc: types.DocumentBlockNode) → { TocEntry }
markdown.renderHtml(doc: types.DocumentBlockNode, config: MarkdownConfig) → string

API Reference

Classes

Markdown

Properties

config: types.MarkdownConfig

Markdown.new

Markdown.new(config: MarkdownConfig) → Markdown

Markdown:parse

Markdown:parse(source: string) → types.DocumentBlockNode

Markdown:renderHtml

Markdown:renderHtml(doc: types.DocumentBlockNode) → string

Functions

markdown.parse
markdown.parse(source: string, config: MarkdownConfig) → types.DocumentBlockNode

markdown.toc
markdown.toc(doc: types.DocumentBlockNode) → { TocEntry }

markdown.renderHtml
markdown.renderHtml(doc: types.DocumentBlockNode, config: MarkdownConfig) → string

Types

TocEntry
level: number
id: string
text: string

MarkdownConfig
type MarkdownConfig = types.MarkdownConfig