!Build
!npm bundle size

TS Markdown Builder

Elegant markdown builder with minimal bundle size.

Goal

TypeScript markdown generation library:

- easy to read and write API
- build CommonMark & GFM compliant markdown
- minimal bundle size + tree-shakable

Installation

``sh
npm install ts-markdown-builder
`

Basic usage

`js
import * as md from 'ts-markdown-builder';

const output = md.joinBlocks([
md.heading('Welcome to TS Markdown Builder'),
"It's an easy to use modern markdown generator.",
'It supports:',
md.list([
${md.bold('bold')} and ${md.italic('italic')},
${md.code('code')} spans and code blocks,
'unordered and ordered lists',
'blockquotes',
'and more!',
]),
]);
`

`markdown


Welcome to TS Markdown Builder

It's an easy to use modern markdown generator.

It supports:

- bold and _italic_
- \code\ spans and code blocks
- unordered and ordered lists
- blockquotes
- and more!
`

Functions

$3

- [joinBlocks(blocks: string[])](https://github.com/mdjastrzebski/ts-markdown-builder/blob/main/API.md#joinblocks) - join blocks of text into a single markdown document (string)

$3


- heading(text: string, options?: { level: number = 1 })
- [blockquote(text: string | string[])](https://github.com/mdjastrzebski/ts-markdown-builder/blob/main/API.md#blockquote)
- codeBlock(text: string, options?: { language?: string = '' })
- [list(items: string[])](https://github.com/mdjastrzebski/ts-markdown-builder/blob/main/API.md#list)
- [orderedList(items: string[])](https://github.com/mdjastrzebski/ts-markdown-builder/blob/main/API.md#orderedlist)
- [taskList(items: (string | TaskListItem)[])](https://github.com/mdjastrzebski/ts-markdown-builder/blob/main/API.md#tasklist) - GFM task list with checkboxes (items can be strings or { text: string, done?: boolean })
- horizontalRule

$3

- bold(text: string)
- italic(text: string)
- strikethrough(text: string) - GFM strikethrough
- code(text: string)
- link(url: string, text?: string) - link or autolink
- image(url: string, text?: string)
- escape(text: string)

$3

- [table(headers: string[], rows: string[][])](https://github.com/mdjastrzebski/ts-markdown-builder/blob/main/API.md#table)

$3

- disclosure(title: string, content: string, options?: { open?: boolean })
- lineBreak`

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

Reference

See the full API Reference for detailed documentation, parameter descriptions, and usage examples.