all repos — markup @ 12d1bbe21d66878eb6f208782024d4ce0582f5fa

The code we use to render README.your_favorite_markup

Link to markup docs
tekkub tekkub@gmail.com
Fri, 18 Jun 2010 20:43:35 -0600
commit

12d1bbe21d66878eb6f208782024d4ce0582f5fa

parent

6461056bfaa7e8d72ca7963a34dd7be683aac1ca

1 files changed, 11 insertions(+), 8 deletions(-)

jump to
M README.mdREADME.md

@@ -7,14 +7,17 @@

Markups ------- -* .markdown - `gem install markdown` -* .textile - `gem install RedCloth` -* .rdoc -* .org - `gem install org-mode` -* .rst - `easy_install docutils` -* .asciidoc - `brew install asciidoc` -* .pod - `Pod::Simple::HTML` should come with Perl -* .1 - Requires `groff` +The following markups are supported. The dependencies listed are required if +you wish to run the library. + +* [.markdown](http://daringfireball.net/projects/markdown/) -- `gem install markdown` +* [.textile](http://www.textism.com/tools/textile/) -- `gem install RedCloth` +* [.rdoc](http://rdoc.sourceforge.net/) +* [.org](http://orgmode.org/) -- `gem install org-mode` +* [.rst](http://docutils.sourceforge.net/rst.html) -- `easy_install docutils` +* [.asciidoc](http://www.methods.co.nz/asciidoc/) -- `brew install asciidoc` +* [.pod](http://search.cpan.org/dist/perl/pod/perlpod.pod) -- `Pod::Simple::HTML` *should come with Perl* +* .1 - Requires [`groff`](http://www.gnu.org/software/groff/) Contributing