search
LoginSignup
80

More than 5 years have passed since last update.

posted at

updated at

redmineでGitHubのMarkdown記法を利用する

Redmine textileのフォーマットはいやだという人のために、いま流行りのGithub Markdown形式でredmineのwiki, チケットを編集するプラグインRedmine Redcarpet Markdown Formatterを紹介する。他にも似たプラグインはあるらしいけど、Githubとの互換性と高速性が特徴とのこと。

インストール

Redcarpet Formatterの動作にはRedcarpet 2.0.0b5以降のバージョンが必要とのことなので、バージョン指定でgemを使ってインストールする。

$ sudo gem install --version 2.0.0b5 redcarpet

次に以下のサイトから、アクセスurlをコピーしてプラグインディレクトリにコピーする.

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

redmineのプラグインディレクトリに移動し、git cloneする。

$ cd <redmine>
$ cd plugins
$ sudo git clone https://github.com/alminium/redmine_redcarpet_formatter.git
($ sudo chmod -R www-data.www-data redmine_redcarpet_formatter)
$ cd ..
$ sudo rake redmine:plugins:migrate RAILS_ENV=production

<redmine>にはそれぞれのredmineのルートディレクトリを代入すること。また、上記はubuntu環境を想定しているので、sudoが必要なかったり、chmodのユーザ・グループ名は各自読み替えたりする必要があります。(rakeのコマンドはredmine2.0以降のコマンドになります)

展開が終了したら、apacheを再起動します(redmineがapache+passengerで運用されている場合に限ります)

$ sudo apache2ctl restart

設定

基本的に設定はありません。アドミニストレータ権限のあるユーザが

「管理」→「設定」→「テキスト書式」

の部分をtextileから、markdownに変更するだけです。

注意:変更するとこれまで編集してきたwikiのフォーマットをすべて入れ替える必要があります。

その他、Tips

redmine固有と思われる記法への対応を挙げておきます。

アップロードした画像へのリンク

  • 元の記法
!imagefile.png!
  • Markdown記法
![title](imagefile.png)

 参考文献

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
What you can do with signing up
80