WPにmarkdown を設定してみる

markdownを覚えようと、WP用のエディタを入れてみる。

Markdown を使う

変更頻度が高いドキュメントや特定のアプリが無いとドキュメントが更新できないのはストレスが溜まる。

プログラマにとって、プログラムの変更はある程度想定できる作業なので仕方がない。しかし、プログラムの変更に応じて、設計書や説明書などのドキュメントを変更するのには結構ストレスがかかる。更に、Wordのバージョンが変わるなど作業環境が変わる場合は、バージョンによって表現が変わるのは最もストレスがかかる作業だ。

そこで、テキストエディタ(老齢プログラマはvimを愛用している)でドキュメントを変更できることはうれしい限りである。

昔はソースコード上に関数仕様や変更履歴などを記しておき、コマンド(老齢プログラマは make docmake diff などで実行していた)で、ドキュメントが出力(texで成形)されるようにしていたのだが、今はもっぱら word、excel、visio になっている。

excelなどは、ファイル内の保存形式がテキストではないため、変更があった場合に、どこが変わったかをexcel自身で保存することができない。(xml形式で保存し、その差分を管理すればできるが、本文以外のところの差分もあり、結構面倒だ)

それに比べるとソースファイル内で管理できれば、sccsSubversionGit)などで変更点が管理でき、わかり易いし便利だ。

テキストファイル形式で、ヘッダーや表などを表現できる markdown は便利だ。reStructuredText もいいかもしれない。

(老齢プログラマは、現在 markdown でドキュメントを残す練習中です。)

そこで、ブログも markdown で書ければ練習になるな。と、markdown のプラグインを探してみた。

すると、 JP markdown というのがあったので入れてみた。

インストール&設定

 

インストールは、普通にプラグインの検索文字を「markdown」として検索すると、検索結果欄に JP markdown が見つかるので、そのまま設定した。

あっという間にインストールできた。簡単すぎ?

markdown の記法

markdown の書き方はいろいろな人が書いているのでそちらを参考にどうぞ

  • Wiki

Markdown wiki

  • qiita.com

Markdown記法 サンプル集

Markdown記法 チートシート