Project

markd

0.0
No commit activity in last 3 years
No release in over 3 years
markd is html builder for markdown, textile and wiki. markd makes well-formatted html with CSS and prittfied code by Google Code Prettify.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.0.0

Runtime

 Project Readme

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).