redmine_markdown_formatter

redmine_markdown_formatter copied to clipboard

= 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:http://www.redmine.org>)) for more details.

== What is Markdown? (from http://daringfireball.net/projects/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:http://daringfireball.net/projects/markdown/>)) for more details.

== Plugin installation === Prerequisites

• Redmine and its prerequisites
• rdiscount gem - see http://tomayko.com/writings/ruby-markdown-libraries-real-cheap-for-you-two-for-price-of-one

=== 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 (http://github.com/yugui) 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.