読者です 読者をやめる 読者になる 読者になる

UNIX的なアレ

UNIX的なこととかいろいろ

marked + markdown-modeの組み合わせが素晴らしい

emacs

ドキュメントはmarkdownで書きたい!

f:id:wadap:20130915153741p:plain

markdown記法がエンジニアの間ではドキュメントを書く上でのデファクトスタンダードになりつつあります。あの手の記法を取り入れることのメリットは、文章を構造化できることですね。

無駄にだらだらと長い文章を書くのではなく、見出しがあってリストがあってのように構造化された文章を書くことで考えが整理できるというメリットがあります。自分自身のメモなどにもすごく便利。

github上で書くとかなら問題はないのですが、自分自身のローカルのテキストエディタで書く場合、できればviewer的なものがあると嬉しかったりします。markdownエディターとしてkobitoはなかなか優秀なのですが、emacs厨としてemacs上で書きたい。保存はhowm上にしたい。

なんか良い方法はないものか、と探していたところmarkedというアプリを発見しました。

markdownビュワー marked

Marked - smart tools for smart writers

Mac App Store - Marked

markdownで書かれた文章のビュワーというシンプルなアプリです。marked自体にはエディタ機構はもっていません。そのため、自分の好きなエディタで記述することができます。

また、エディタ側から呼び出すことができるので途中までかいて見たいときにだけmarkedを呼び出すという使い方できます。これが非常に便利。

以下の設定をいれるだけで、C-cmで呼び出せるようになります。超便利!

(defun markdown-preview-file ()
  "run Marked on the current file and revert the buffer"
  (interactive)
  (shell-command 
   (format "open -a /Applications/Marked.app %s" 
       (shell-quote-argument (buffer-file-name))))
)
(global-set-key "\C-cm" 'markdown-preview-file)

このあたりを参考に。

Marked Bonus Pack (scripts, commands and bundles) / How-to, tips and tricks / Knowledge Base - Marked Support

code blockにも対応したい

デフォルトではcode blockには対応していません。以下の設定を入れると対応します。

f:id:wadap:20130915154814p:plain

f:id:wadap:20130915154824p:plain

ドキュメントの保存先は!

ローカルで書くとどこに保存するの?というのが問題になりますが、私は長年howmを使っています。 保存先も気にしなくていいですし、ファイル名も作らなくていいので、すぐにメモを取れます。

howmのドキュメントの保存先をDropboxにしておくとさらに便利ですよ。