IT エンジニア向け Confluence と Markdown を仲良くさせる方法

Confluence は Atlassian 社の企業向け Wiki 環境。WYSIWYG ベースで「誰にでも」ドキュメントが書ける環境を提供する。パーミッション管理やプラグインが充実しているのも魅力の一つ。

Confluence は、昔は Textile ベースの Wiki 環境だったと聞くけれど、今は独自のエディターを用意して WYSIWYG 環境を提供している。WYSIWYG は「誰にでも」書けるのが魅力だけど、エンジニアには受けが良くない。エンジニアはプレイン・テキストでサッとドキュメントを書くのを好むから。できれば Markdown か Textile のようなライトな Wiki 言語を使いたい。

一応、Confluence は Markdown マクロを持っている。{markdown}...{markdown} の中に書いたテキストは Markdown としてレンダリングされる。だけど出来が良くない。期待した通りの出力にならなかったり、書き方にクセがあったり、レンダリングに時間がかかったり...

Markdown と一緒に使う

そこでお勧めなのが Markdown プレビュー機能付きエディターを使う方法。MacDown とか Ulysses とか Byword とか。そういったエディターで Markdown を書く。プレビューさせる。そして、プレビューから Confluence に記入したい部分をコピーする。Confluence に貼り付ければ、あら不思議、望んだ通りの書式でテキストが挿入される。

タイトルも、箇条書きも、リンクも望み通り。あ、テーブルはまだ書いていないので、誰か試したら結果を教えて欲しい。

あとがき

今までは、Markdown でテキスト書いて、テンポラリー・バッファーで Markdown 書式を削って、Confluence に貼り付けて、WYSIWYG で書式を付け直していた。それがプレビューからコピーするだけになって、大幅に無駄な作業が減った。ありがたい。これなら Confluence と仲良くなれる気がする。

なお、ぼくは Markdown のプレビューに Emacs の markdown モードを使っている。markdown-mode については後日、また記事にしたい。