Project

General

Profile

Actions

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を利用した開発にもスムーズに移れます。
  • 日本語ヘルプで初心者にも優しい
    • Wikiツールバーはもちろんのこと、Wikiのヘルプを日本語で表示します(言語を日本語に設定している場合)。初心者にもお勧めです。

インストール

Redcarpet Formatterの動作にはRedcarpet 2.0.0b5以降のバージョンが必要です。下記のようにバージョンを指定してgemでインストールしてください。

#gem install --version 2.0.0b5 redcarpet

Redmine Redcarpetプラグインを下記のサイトから取得しインストール(REDMINE_HOME/vendor/pluginsにコピー)します。

Redmine Markdown Formatterプラグインが既にインストールされている場合、正しく動作しません。Redmine Markdown Formatterプラグインをアンインストール(プラグインディレクトリを削除)してから利用してください。

Redmineのルートディレクトリで、

# rake db:migrate_plugins

を実行します。

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

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

このRedmine Redcarpet Formatterプラグインは、Redmine/SCM+Pluginの統合インストーラ ALMinium の成果として提供しています。

Updated by - - over 11 years ago · 9 revisions