markdown

Pool

Modern, tree-shakeable markdown parser with TypeScript support

$ lpm install @lpm.dev/[email protected]

README API Skills4 Dependencies Versions4

16 exportsTypeScript

dist

Functions

parse

function parse(markdown: string, options?: ParserOptions): string

Parse markdown to HTML

Parameter	Type	Description
`markdown`	`string`	- Markdown source string
`options`optional	`ParserOptions`	- Parser options

dist/blocks

Classes

Tokenizer

Tokenizer class for parsing markdown into block tokens

constructor(options?: ParserOptions)

Method	Return Type	Description
`tokenize(src)`	`BlockToken[]`	Tokenize markdown string into block tokens

dist/blocks

Classes

Tokenizer

Tokenizer class for parsing markdown into block tokens

constructor(options?: ParserOptions)

Method	Return Type	Description
`tokenize(src)`	`BlockToken[]`	Tokenize markdown string into block tokens

dist

Functions

parse

function parse(markdown: string, options?: ParserOptions): string

Parse markdown to HTML

Parameter	Type	Description
`markdown`	`string`	- Markdown source string
`options`optional	`ParserOptions`	- Parser options

dist/inline

Classes

InlineTokenizer

Inline tokenizer class

Method	Return Type	Description
`tokenize(src)`	`InlineToken[]`	Tokenize inline markdown string Phase 6: Optimized with fast-path checks to avoid unnecessary regex execution

dist/inline

Classes

InlineTokenizer

Inline tokenizer class

Method	Return Type	Description
`tokenize(src)`	`InlineToken[]`	Tokenize inline markdown string Phase 6: Optimized with fast-path checks to avoid unnecessary regex execution

dist/parser-DK7OdLHB

Functions

createParser

function createParser(options?: ParserOptions): Parser

Create a new parser instance

Parameter	Type	Description
`options`optional	`ParserOptions`	- Parser options

Classes

MarkdownParserimplements Parser

Markdown parser implementation

constructor(options?: ParserOptions)

Method	Return Type	Description
`parse(markdown)`	`string`	Parse markdown to HTML
`tokenize(markdown)`	`BlockToken[]`	Tokenize markdown to block tokens
`render(tokens)`	`string`	Render tokens to HTML

dist/parser-VRehub_R

Functions

createParser

function createParser(options?: ParserOptions): Parser

Create a new parser instance

Parameter	Type	Description
`options`optional	`ParserOptions`	- Parser options

Classes

MarkdownParserimplements Parser

Markdown parser implementation

constructor(options?: ParserOptions)

Method	Return Type	Description
`parse(markdown)`	`string`	Parse markdown to HTML
`tokenize(markdown)`	`BlockToken[]`	Tokenize markdown to block tokens
`render(tokens)`	`string`	Render tokens to HTML

dist/presets/commonmark

Functions

parse

function parse(markdown: string, options?: Partial<ParserOptions>): string

Parse markdown using CommonMark preset

Parameter	Type	Description
`markdown`	`string`	- Markdown source string
`options`optional	`Partial<ParserOptions>`	- Additional parser options

dist/presets/commonmark

Functions

parse

function parse(markdown: string, options?: Partial<ParserOptions>): string

Parse markdown using CommonMark preset

Parameter	Type	Description
`markdown`	`string`	- Markdown source string
`options`optional	`Partial<ParserOptions>`	- Additional parser options

dist/presets/gfm

Functions

parse

function parse(markdown: string, options?: Partial<ParserOptions>): string

Parse markdown using GFM preset

Parameter	Type	Description
`markdown`	`string`	- Markdown source string
`options`optional	`Partial<ParserOptions>`	- Additional parser options

dist/presets/gfm

Functions

parse

function parse(markdown: string, options?: Partial<ParserOptions>): string

Parse markdown using GFM preset

Parameter	Type	Description
`markdown`	`string`	- Markdown source string
`options`optional	`Partial<ParserOptions>`	- Additional parser options

dist/renderer-Ce7kgJDN

Classes

HtmlRendererimplements Renderer

Default HTML renderer implementation

Method	Return Type	Description
`heading(token)`	`string`	Render heading
`paragraph(token)`	`string`	Render paragraph
`code(token)`	`string`	Render code block
`hr(_token)`	`string`	Render horizontal rule
`blockquote(token)`	`string`	Render blockquote
`list(token)`	`string`	Render list
`listitem(token)`	`string`	Render list item Phase 4: Added support for task list checkboxes (GFM extension)
`html(token)`	`string`	Render HTML (if allowed)
`table(token)`	`string`	Render table
`tablerow(cells)`	`string`	Render table row
`tablecell(text, align, header)`	`string`	Render table cell
`text(token)`	`string`	Render text
`strong(token)`	`string`	Render strong (bold)
`em(token)`	`string`	Render emphasis (italic)
`del(token)`	`string`	Render strikethrough (del) Phase 4: GFM extension
`codespan(token)`	`string`	Render inline code
`link(token)`	`string`	Render link
`image(token)`	`string`	Render image
`br(_token)`	`string`	Render line break
`renderBlock(tokens)`	`string`	Render block tokens to HTML
`renderInline(tokens)`	`string`	Render inline tokens to HTML

dist/renderer-D875hnGA

Classes

HtmlRendererimplements Renderer

Default HTML renderer implementation

Method	Return Type	Description
`heading(token)`	`string`	Render heading
`paragraph(token)`	`string`	Render paragraph
`code(token)`	`string`	Render code block
`hr(_token)`	`string`	Render horizontal rule
`blockquote(token)`	`string`	Render blockquote
`list(token)`	`string`	Render list
`listitem(token)`	`string`	Render list item Phase 4: Added support for task list checkboxes (GFM extension)
`html(token)`	`string`	Render HTML (if allowed)
`table(token)`	`string`	Render table
`tablerow(cells)`	`string`	Render table row
`tablecell(text, align, header)`	`string`	Render table cell
`text(token)`	`string`	Render text
`strong(token)`	`string`	Render strong (bold)
`em(token)`	`string`	Render emphasis (italic)
`del(token)`	`string`	Render strikethrough (del) Phase 4: GFM extension
`codespan(token)`	`string`	Render inline code
`link(token)`	`string`	Render link
`image(token)`	`string`	Render image
`br(_token)`	`string`	Render line break
`renderBlock(tokens)`	`string`	Render block tokens to HTML
`renderInline(tokens)`	`string`	Render inline tokens to HTML