Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A near-perfect GitHub style Markdown to HTML converter
branch: master

This branch is 2 commits ahead, 20 commits behind rvagg:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
.gitignore
LICENSE
README.md
index.js
package.json
test.js

README.md

Brucedown

A near-perfect GitHub style Markdown to HTML converter

A very simple processor that leans heavily on dependencies to get the job done.

Built primarily for Morkdown but useful wherever you want to produce the same HTML that GitHub does when processing Markdown.

There are some very minor differences due to the fact that Brucedown uses Marked (JavaScript) rather than Sundown (C) for the Markdown conversion.

Brucedown uses Pygments to do syntax highlighting just like GitHub so code even comes out the same.

Currently the interface is very simple:

var brucedown = require('brucedown')

brucedown(markdownSource, function (err, htmlResult) {
  console.log(htmlResult)
})

Licence & copyright

Brucedown is Copyright (c) 2012 Rod Vagg @rvagg and licenced under the MIT licence. All rights not explicitly granted in the MIT license are reserved. See the included LICENSE file for more details.

Something went wrong with that request. Please try again.