Skip to content

An absurdly simple script for rendering markdown with github styles.

Notifications You must be signed in to change notification settings

dmac/markdown_doctor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

35 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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>

About

An absurdly simple script for rendering markdown with github styles.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages