Get Started

Welcome to Bun Installation Quickstart TypeScript TypeScript 6 and 7

Watch Mode Debugging REPL bunfig.toml File Types Module Resolution JSX Auto-install Plugins File System Router

Cookies File I/O Streams Binary Data Archive SQL SQLite S3 Redis Workers Environment Variables Shell Spawn WebView Cron Node-API FFI C Compiler Transpiler CSRF Protection Secrets Console TOML YAML Markdown JSON5 JSONL HTMLRewriter Image Hashing Glob Semver Color Utils Globals Bun APIs Web APIs Node.js Compatibility

Standards & Compatibility

Markdown

Parse and render Markdown with Bun's built-in Markdown API, supporting GFM extensions and custom rendering callbacks

YAML

Use Bun's built-in support for YAML files through both runtime APIs and bundler integration

JSON5

Use Bun's built-in support for JSON5 files through both runtime APIs and bundler integration

On this page

Bun.markdown.html()Options Autolinks Heading IDs Bun.markdown.render()Callback signature Block callbacks List item meta Inline callbacks Examples Custom HTML with classes Stripping all formatting Omitting elements ANSI terminal output Nested list numbering Code block syntax highlighting Parser options Bun.markdown.react()Server-side rendering Component overrides Available overrides React 18 and older Parser options