Browse files


  • Loading branch information...
0 parents commit dd40a6bc8bc2c065bd3a4abb5d3f9ae49f2ff671 @bitherder committed Nov 14, 2008
Showing with 39 additions and 0 deletions.
  1. +39 −0 README
@@ -0,0 +1,39 @@
+= Redmine Markdown formatter
+This is a redmine plugin for supporting Markdown as a wiki format.
+== What is redmine?
+Redmine is a flexible project management web application.
+See ((<the official site|URL:>)) for more details.
+== What is Markdown?
+Markdown is a text-to-HTML conversion tool for web writers. Markdown allows
+you to write using an easy-to-read, easy-to-write plain text format, then
+convert it to structurally valid XHTML (or HTML).
+See ((<the article on John Gruber's blog|URL:>))
+for more details.
+== Plugin installation
+=== Prerequisites
+* Redmine and its prerequisites
+* rdiscount gem - see
+=== Installation
+(1) Copy the plugin directory into the vendor/plugins directory
+(2) Start Redmine
+Installed plugins are listed on 'Admin -> Information' screen.
+=== Credits
+* Yuki Sonoda ( did the real work by creating the
+ redmine_rd_formatter
+* Jean-Philippe Lang for making the change to RedMine (based on Yuki's patch) to
+ allow pluggable formatters
+== Future Plans
+* make the blockquote and unblockquote work for list items to indent
+ and un-indent. Current behavior is kind of confusing.

1 comment on commit dd40a6b


I wrote the README for redmine_rd_formatter in RD. Why don't you write your one in markdown?

Please sign in to comment.