rich html builder for markdown, wiki and textile
Ruby JavaScript
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
template
test
.document
.gitignore
CHANGELOG.md
Gemfile
README.md
Rakefile
VERSION
markd.gemspec

README.md

markd

markd is rich html builder for markdown, wiki and textile format. It is especially focused on printing purpose. You can get well-formatted printings (or PDF by preview) when you print html using modern browser (such as Google Chrome, Firefox, Safari).

markd is based on BlueCloth, RedCloth, Wikitext and google code prittify.

features:

  • Well-formatted HTML with CSS
  • Good style for printings
  • Auto numbered chapters
  • Code Highlighting

Installation

You can install markd using RubyGems as below:

$ gem install markd

Usage

Build html from markdown:

$ markd -o out_dir markdown.md

where markdown.md is target markdown file and out_dir is directory that html/css/js files are generated into.

$ markd *.md

Or simply give source markdwon file(s). Multiple files are acceptable. Default output directory is "docs".

Use -h (or --help) option to show detail.

$ markd -h

Engines

markd has three engines:

  • Markdown (default)
  • Textile
  • Wiki

markd automatically select engine by file extention (.md for Markdown, .textile for Textile, .wiki for Wiki).

Instructions

See more instructions:

License

markd is released under the MIT license.

Copyright

Copyright (c) 2011 daisuke sugimori (@daixque).