GitHub Markup

We use this library on GitHub when rendering your README or any other rich text file.

Markups

The following markups are supported. The dependencies listed are required if you wish to run the library.

• .markdown -- gem install rdiscount
• .textile -- gem install RedCloth
• .rdoc
• .org -- gem install org-ruby
• .creole -- gem install creole
• .rst -- easy_install docutils
• .asciidoc -- brew install asciidoc
• .pod -- Pod::Simple::HTML comes with Perl >= 5.10. Lower versions should install Pod::Simple from CPAN.
• .1 - Requires groff

Contributing

Want to contribute? Great! There are two ways to add markups.