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.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!',
  ]),
].join('\n\n');

# 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!

Contributing

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

License

MIT

Reference

TODO