README.md

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

npm install ts-markdown-builder

Basic usage

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!',
  ]),
]);

# 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

Utils

• joinBlocks(blocks: string[]) - join blocks of text into a single markdown document (string)

Block

• heading(text: string, options?: { level: number = 1 })
• blockquote(text: string | string[])
• codeBlock(text: string, options?: { language?: string = '' })
• list(items: string[])
• orderedList(items: string[])
• taskList(items: (string | TaskListItem)[]) - GFM task list with checkboxes (items can be strings or { text: string, done?: boolean })
• horizontalRule

Inline

• 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)

Table

• table(headers: string[], rows: string[][])

HTML

• 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.