markdown

Pool

Modern, tree-shakeable markdown parser with TypeScript support

$ lpm install @lpm.dev/neo.markdown

README API Skills4 Dependencies1 Versions4

33 exportsTypeScript

dist/blocks

Variables

codeBlockRule

Fenced code block rule (``` or ~~~)

indentedCodeBlockRule

Indented code block rule (4 spaces or tab)

headingBlockRule

ATX heading rule (# heading)

setextHeadingBlockRule

Setext heading rule (underlined with === or ---)

hrBlockRule

Horizontal rule (---, ***, ___)

tableBlockRule

GFM table rule

blockquoteBlockRule

Blockquote rule (> prefix)

listBlockRule

List rule (ordered and unordered, with task list support)

htmlBlockRule

HTML block rule (only active when allowHtml is true)

paragraphBlockRule

Paragraph rule (fallback for unmatched content)

allBlockRulesBlockRule[]

All built-in block rules in default priority order

dist/core

Classes

PluginBuilderImplimplements PluginBuilder

Internal plugin builder that collects plugin registrations

constructor(renderer: HtmlRenderer, options: ParserOptions)

Method	Return Type	Description
`addBlockRule(rule)`	`void`
`addInlineRule(rule)`	`void`
`setRenderer(method, fn)`	`void`
`addTokenTransform(fn)`	`void`
`addHtmlTransform(fn)`	`void`
`renderInline(tokens)`	`string`
`renderBlock(tokens)`	`string`

Property	Type	Description
`options`	`Readonly<ParserOptions>`
`blockRules`	`BlockRule[]`	Collected custom block rules
`inlineRules`	`InlineRule[]`	Collected custom inline rules
`rendererOverrides`	Map<keyof Renderer, ((token: HeadingToken) => string) \| ((token: ParagraphToken) => string) \| ((token: CodeToken) => string) \| ((token: HrToken) => string) \| ((token: BlockquoteToken) => string) \| ((token: ListToken) => string) \| ((token: ListItemToken) => string) \| ((token: HtmlBlockToken \| HtmlInlineToken) => string) \| ((token: TableToken) => string) \| ((cells: string[]) => string) \| ((text: string, align: "left" \| "center" \| "right" \| null, header: boolean) => string) \| ((token: DirectiveToken) => string) \| ((token: TextToken) => string) \| ((token: StrongToken) => string) \| ((token: EmToken) => string) \| ((token: DelToken) => string) \| ((token: CodeInlineToken) => string) \| ((token: LinkToken) => string) \| ((token: ImageToken) => string) \| ((token: BrToken) => string)>	Collected renderer overrides (method name → function)
`tokenTransforms`	`Array<(tokens: BlockToken[]) => BlockToken[]>`	Collected token transforms (run after tokenization)
`htmlTransforms`	`Array<(html: string) => string>`	Collected HTML transforms (run after rendering)

dist/index-Bfx7r7DE

Classes

InlineTokenizer

Inline tokenizer class

constructor(customRules?: InlineRule[], options?: InlineTokenizerOptions)

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

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

Variables

DEFAULT_ALLOWED_TAGSSet<string>

Default allowed tags (GitHub README-compatible)

DEFAULT_ALLOWED_ATTRIBUTESRecord<string, Set<string>>

Default allowed attributes per tag

dist/parser-BtuCD2P6

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/plugins/copy-code

Functions

copyCodePlugin

function copyCodePlugin(options?: CopyCodeOptions): MarkdownPlugin

Create the copy-code plugin

Parameter	Type	Description
`options`optional	`CopyCodeOptions`	- Copy-code options

dist/plugins/embeds

Functions

embedPlugin

function embedPlugin(options?: EmbedOptions): MarkdownPlugin

Create the embed plugin

Parameter	Type	Description
`options`optional	`EmbedOptions`	- Embed options

dist/plugins/embeds/react

Variables

YouTubeFC<YouTubeProps>

VimeoFC<VimeoProps>

TweetFC<TweetProps>

CodeSandboxFC<CodeSandboxProps>

CodePenFC<CodePenProps>

LoomFC<LoomProps>

dist/plugins/highlight

Functions

parseHighlightLines

function parseHighlightLines(meta?: string): number[] | undefined

Parse highlight line ranges from meta string Supports formats: {1,3-5}, {1}, {1,2,3}

Parameter	Type	Description
`meta`optional	`string`	- Code block meta string

highlightPlugin

function highlightPlugin(options: HighlightOptions): MarkdownPlugin

Create the highlight plugin

Parameter	Type	Description
`options`	`HighlightOptions`	- Highlight options (grammars, tokenize, renderToHTML, theme, lineNumbers)

dist/plugins/toc

Functions

tocPlugin

function tocPlugin(options?: TocOptions): MarkdownPlugin

Create the TOC plugin

Parameter	Type	Description
`options`optional	`TocOptions`	- TOC 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/renderer-Cc9gtqGb

Classes

HtmlRendererimplements Renderer

Default HTML renderer implementation

constructor(options?: HtmlRendererOptions)

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
`directive(_token)`	`string`	Render directive (default: no-op, plugins override this)
`applyOverrides(overrides)`	`void`	Apply renderer method overrides from plugins
`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/tokenizer-D0tixoEg

Classes

Tokenizer

Tokenizer class for parsing markdown into block tokens

constructor(options?: ParserOptions, customRules?: BlockRule[])

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

Unlimited AccessInstall as many Pool packages as you need.

Fund Real WorkEvery install you run sends revenue directly to the developer who built it.

Taxes calculated at checkout based on your location.

Insights

94/100Excellent

Weekly Installs

Version

1.2.1

Published

Repository

github.com(opens in new tab)

Website

neo-demos.vercel.app(opens in new tab)

LicenseMIT

Size1.91 MB

Files84

Node version>= 18

TypeScriptYes