Usage

Embedded Maruku

This is the basic usage:

require 'rubygems'
require 'maruku'

doc = Maruku.new(markdown_string)
puts doc.to_html

The method to_html outputs only an HTML fragment, while the method to_html_document outputs a complete XHTML 1.0 document:

puts doc.to_html_document

You can have the REXML document tree with:

tree = doc.to_html_document_tree

From the command line

There is one command-line program installed: maruku.

Without arguments, it converts Markdown to HTML:

$ maruku file.md  # creates file.html

With the --pdf arguments, it converts Markdown to LaTeX, then calls pdflatex to transform to PDF:

$ maruku --pdf file.md  # creates file.tex and file.pdf