0.4.0 • Published 10 months ago

ts-markdown-builder v0.4.0

Weekly downloads
-
License
MIT
Repository
github
Last release
10 months ago

npm version Build npm bundle size PRs Welcome Star on GitHub

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

0.4.0

10 months ago

0.3.0

10 months ago

0.2.2

11 months ago

0.2.1

11 months ago

0.2.0

11 months ago

0.1.0

11 months ago