r-labs

Redmine Redcarpet Markdown Formatter¶

はじめに¶

RedmineのWikiフォーマットtextileは人によっては使いづらいと感じるかもしれません。Redmine Redcarpet Formatterは、Markdown形式でWiki、チケット、コミットログを書けるようにするプラグインです。

特徴¶

RedmineでMarkdownフォーマットを利用するプラグインとしてRedmine Markdown FormatterやRedmine Markdown Extra Formatterなどがあります。Redmin Redcarpet Formatterがこれらを決定的に違う点は、

• 超高速
  • MarkdownプロセッサにGitHubで採用されているRedcarpetを採用しています。Wikiエンジンの性能はWikiだけでなくチケットやコミットログなど、Wiki形式のドキュメントを利用する箇所へ影響を与えます。Redmine Redcarpet Formatterにより快適にRedmineを利用できるようになります。

• GitHubと高い互換性
  • GitHubで採用しているRedcarpetを利用することにより、GitHubのWikiと高い互換性を持っています。Git基盤として広く使われているGitHubに慣れている人なら簡単に利用できます。また、将来的にRedmineからGitHubを利用した開発にもスムーズに移れます。

インストール¶

Redcarpet 2.0.0b5以降のバージョンをインストールする必要があります。gemリポジトリのredcarpetのgemはバージョンが古いので、下記のサイトから入手してインストールしてください。

• https://github.com/tanoku/redcarpet

Redmine Redcarpetプラグインを下記のサイトから取得しインストールします。

• https://github.com/alminium/redmine_redcarpet_formatter

以上。

バグ報告、機能要望、パッチなど¶

GitHubを利用して、開発しているので、取り敢えず下記のGitHubまでお願いします。

• https://github.com/alminium/redmine_redcarpet_formatter