bhollis/maruku

View on GitHub
docs/website/src/index.page

Summary

Maintainability
Test Coverage
---
page_class: index
linkAttrs:
  :link_text: Home
inMenu: true
title: "Maruku: a Markdown-superset interpreter"
description:  "Maruku: a Markdown-superset interpreter"
---
CSS: style.css
Use numbered headers: true
HTML use syntax: true
LaTeX use listings: true
LaTeX CJK: false
LaTeX preamble: preamble.tex

<!--![MaRuKu](logo.png){#logo}-->

Maruku is a [Markdown] interpreter written in [Ruby].

> The official repository has moved to GitHub: <a href="http://github.com/nex3/maruku">http://github.com/nex3/maruku</a>
{#news}

> [The last GEM release](changelog.html#stable) is version 0.6.0 -- 2009-05-04.
{#news}

![data flow](diagram.png){#dataflow}




__Authors__: Maruku was started by [Andrea Censi]. The current maintaner is
<a href="http://nex-3.com/">Nathan Weizenbaum</a>. Many other people contributed patches; a partial list is in the AUTHORS file in the source distribution.

__The name of the game__: Maruku is the [romaji] transliteration of 
the [katakana] transliteration
of "Mark", the first word in Markdown. I chose this name because Ruby 
is Japanese, and also the syllable "ru" appears in Maruku.

### Do you like this software? ###

How about [a donation to Wikipedia][wiki]? (and please, if you do donate, let me know).

[wiki]: http://wikimediafoundation.org/wiki/Fundraising

### Bugs report ###

Use the [tracker][tracker] or [drop me an email][contact].

[contact]: http://www.cds.caltech.edu/~andrea/contact.html
[gem]: http://rubygems.rubyforge.org/
[tracker]: http://rubyforge.org/tracker/?group_id=2795


[romaji]: http://en.wikipedia.org/wiki/Romaji
[katakana]: http://en.wikipedia.org/wiki/Katakana
[andrea censi]: http://www.cds.caltech.edu/~andrea/
[ruby]: http://www.ruby-lang.org/
[maruku]: http://maruku.rubyforge.org/
[Markdown]: http://en.wikipedia.org/wiki/Markdown