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

interprism's blog

インタープリズム株式会社の開発者ブログです。

Markdown記法でメモを取ろう

こんにちは、kamogawaです。

この投稿は インタープリズム的「俺達私達の進捗を上げる25個前後のTips」 Advent Calendar 2015 - Qiitaの4日目 の記事です。

自分は普段テキストファイルでメモをとっています。ノートなどに手書きで取ったメモも、再度整理してテキストファイルに入力することが多いです。二度と見返さないメモも多く過剰かなとも思う一方、最近周辺で「アナログ手書きで取るよ」派や「メモ自体取らないよ」派に遭遇したので、テキストファイル、特にMarkdown記法でメモをとることの勧めを書いてみたいと思います。

念のため、Markdownについて軽く触れておきます。Wikipediaによれば、

Markdown(マークダウン)は、文書を記述するための軽量マークアップ言語のひとつである。もとはプレーンテキスト形式で手軽に書いた文書からHTMLを生成するために開発された。現在ではHTMLのほかパワーポイント形式やLATEX形式のファイルへ変換するソフトウェア(コンバータ)も開発されている。各コンバータの開発者によって多様な拡張が施されるため、各種の方言が存在する。

Markdown - Wikipedia

とのことで、メインの用途はHTML文書の作成です。

引用文中でいう「方言」というのがなかなか厄介で、エディタやそのプラグイン、またはサービス次第で、実装されていない記法があったり、スペースや改行の扱いが異なっていたりと、ファイルの互換性という点では扱いづらい印象です。個人的なメモに用途を絞るならば、この点はある程度目をつぶることができるかと思います。

メリット

さて、肝心のMarkdownでのメモを勧める理由は、以下のようなメリットがあると考えているからです。

  • GitHubはてなブログ、Qiitaなどで利用されており、アウトプットの際にも役立つ
    • Markdown記法の学習は、個人のメモに限らず、エンジニアにとって有益であろう、知識のアウトプットの際にも役立つと考えられます
  • 記述の手間が少なく、可読性が高い
  • シンタックスハイライトを活用できる
    • 見出しやリスト、コメントアウトなどをエディタによって色を付けて表示することが可能なので、白黒のテキストファイルに比べてさらに可読性を高めることができます

さらに、エディタがAtomであればコードのシンタックスハイライトが可能です。

f:id:interprism:20151127185742p:plain

コード部分をJavaとしてハイライトしてくれています。きれいですね。ちなみにVimでの表示はこんな感じです。

f:id:interprism:20151127185753p:plain

手書きのようにカラフルにでき、編集も容易なMarkdownはメモに最適だと思います。手書き派の方も乗り換えてみてはいかがですか?

拡張子は.txtを使う

ついでにMarkdownでメモを取る際のTipsを一点紹介したいと思います。

Markdownファイルの標準の拡張子.mdですが、一部のスマートフォンでは標準でこのファイルを開けません。そこで、この拡張子.txtとして、中身をMarkdown記法で記述するようにすると、追加のアプリケーションなしでスマートフォンから確認できるようになります。「普段はパソコンで編集し、たまにスマートフォンからも閲覧する」といった用途に便利です。

当然パソコン側のエディタ標準では.txtのファイルをMarkdownファイルとして解釈してくれないので各エディタで設定する必要があります。

Vimの場合、vimrcファイルに以下の一行を追加します。構文はfiletype.vimの内容を参考にしました。

au BufNewFile,BufRead *.txt :set filetype=markdown

Atomの場合、拡張子とファイルタイプの関連付けにはfile-typesというパッケージがよく使われているようです。

MarkdownのScope Nameが分かりにくいのですが、どうやらsource.gfmがそれのようです。gfmGitHub Flavored Markdownの略だと思われます。.txt拡張子をMarkdownに関連付けるためには、config.csonの適切なところに、

txt : "source.gfm"

と記入しましょう。

Sublime Textだと以下の記事あたりでしょうか。

これでパソコンからもスマートフォンからもメモ取り放題ですね!

インタープリズム的「俺達私達の進捗を上げる25個前後のTips」 Advent Calendar 2015 - Qiita5日目の記事

インタープリズムのページ

PAGE TOP