A bonza GitHub-style Markdown to HTML converter
Converts GitHub Flavoured Markdown (GFM) to HTML with syntax highlighting powered by Shiki (the same highlighting engine used by VS Code).
npm install brucedown
import brucedown from 'brucedown'
const markdown = `
# G'day World
Some **bold** text and \`inline code\`.
\`\`\`javascript
const greeting = "G'day!";
console.log(greeting);
\`\`\`
`
const html = await brucedown(markdown)
console.log(html)
import brucedown from 'brucedown'
const html = await brucedown(markdown, {
theme: 'github-dark' // Any Shiki theme
})
brucedown input.md output.html
brucedown input.md > output.html
If you're processing heaps of files in a long-running process and want to free resources when done:
import brucedown, { dispose } from 'brucedown'
// Process your files...
const html = await brucedown(markdown)
// Release Shiki's WASM/grammar resources
dispose()
For CLI usage or short-lived processes, this isn't necessary - process exit handles cleanup.
github-light, github-dark, one-dark-pro, etc.)brucedown(markdown, [options])Converts markdown to HTML.
markdown (string) - The markdown sourceoptions (object, optional)
theme (string) - Shiki theme name (default: 'github-light')Returns: Promise<string> - The resulting HTML
dispose()Releases Shiki's WASM and grammar resources. Only needed for long-running processes; CLI usage doesn't require this.
MIT Licence. Copyright (c) Rod Vagg.