ChiliProject Markdown formatter

This is a redmine plugin for supporting Markdown as a wiki format.

What is ChiliProject?

ChiliProject is a fork of Redmine a flexible project management web application. See the official site 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 for more details.

Plugin installation

Installation

1. Copy the plugin directory into the vendor/plugins directory
2. run bundle to install plugin dependencies
3. Start (or restart) ChiliProject

Dependencies

• ChiliProject and its prerequisites
• albino for Pygments syntax highlighting
• redcarpet gem (>= 2.0.0b5)

Installed plugins are listed on Admin -> Information screen.

Extra Goodies from RedCarpet

By default I enabled __RedCarpet__ʼs :fenced_code_blocks so you can syntax highlight you code snippets whereever you like by specifying the language after three backticks:

```ruby
  def puts msg
    Kernel.puts msg
  end
```

will render as:

  def puts msg
    Kernel.puts msg
  end

To make use of this you have to include a pygments css theme into redmine.

Simply place a pygments css like the Solarized Light Theme under public/stylesheets/pygments/solarized.css and then add the following to app/views/layouts/base.rhtml right after the other stylesheet_link_tags:

<%= stylesheet_link_tag 'pygments/solarized', :media => 'all' %>

Credits

• Larry Baltz for creating the original Redmine Markdown Formatter (using the RDiscount Gem)
• 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