Getting Started

Getting started

Run the install command using your package manger of choice:

npm install bbmd

yarn add bbmd

pnpm add bbmd

Then import b anywhere in your application:

import b from "bbmd";

Features

• Full support for standard, extended, and Github Flavored Markdown syntax specifications
• Additional support for common Markdown hacks like underlines, comments, details, and image captions
• Sub-document and section handling renders your blocks perfectly wherever they're injected
• Concise chaining API that focuses on terseness
• Simple return interfaces enable easy typing for document factories
• Automatic parsing using b.md``.parse() enables quick adoption
• Documents convert to strings automatically using String(doc) or template literals using ${doc} and support .toString()
• Zero dependencies and minimal bundle size

Learn

All blocks