Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

An absurdly simple script for rendering markdown with github styles.

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 bin
Octocat-spinner-32 .gitignore
Octocat-spinner-32 Gemfile
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 markdown_doctor.gemspec
README.md

Markdown Doctor

An absurdly simple script that renders your markdown to html.

Update: The latest and greatest version of this tool is markdownd. It contains many improvements, including the ability to watch for changes to your markdown files and automatically update them in a browser. It's also distributed as a binary and doesn't require Ruby.

Installation

Markdown Doctor uses pygments for syntax highlighting code blocks.

$ gem install markdown_doctor

Note: You'll also need Python installed on your system.

Usage

To output to stdout:

$ markdown_doctor <filename>

To read from stdin and output to stdout:

$ cat "this is a test" | markdown_doctor

To display in a browser:

$ gem install bcat
$ markdown_doctor.rb <filename> | bcat

Try putting this in your .vimrc:

" Quickly display a markdown preview of the current buffer
:map <leader>m :%w ! markdown_doctor \| bcat<CR><CR>
Something went wrong with that request. Please try again.