Web

アウトプットはMarkdownで書け!

注意

この記事は旧ブログからの移植です

どうもお久しぶりです。あむです。
書くことなさ過ぎて放置してました。あむです。
今回はGithubなんか使っている人は必ず使っているであろうMarkdownの素晴らしさを適当に記載していく、脱力記事にしたいと思います。

Markdownってなによ

まずはMarkdownについてですが、詳しくはwikiってください。
百聞は一見に如かず。ここは見て凄さを実感していただきましょう!

記述例

例えば以下のように記述したとします。

1. インストールする
1. 設定する

| 項目 | 値 | 備考 |
| — | — | — |
| 設定1 | ammmmm | アムユーザ |
| せってい2 | なにを記載しようかな | 意外と悩む |

表示例

すると以下のように出力されます。

  1. インストールする
  2. 設定する
項目 備考
設定1 ammmmm アムユーザ
せってい2 なにを記載しようかな 意外と悩む

つまり凄い

もちろん表示側でMarkdownでの記述に対応している必要がありますが、対応していれば面倒くさいHTMLを書く必要もないわけです。
ちなみにはてなブログはMarkdownでの記述に対応しているので今回の記事はMarkdownで記載しています。
ただし、はてなのMarkdownはやや癖があって使いづらい。

Markdown記述にオススメのエディタ

ここでMarkdownを記述するときにオススメなエディタを紹介します。
はい、Atomです。結局これです。Githubが開発してますしね。

これにmarkdown-preview-plus(markdown-previewを強化します。)を導入しましょう。最強です。
ついでにmarkdown-scroll-sync(preview画面が自動スクロールします。多少ズレるのはご愛敬。)も導入しましょう。最強です。

総括

利点はHTMLが簡単に書けるだけではないのです。
パッと思いつく限り。

  • 簡単にHTMLが書ける
  • 書き方にルールがあるので、プレーンテキストとしても見やすくなる
  • テキストで管理できる
  • えっと…

意外となかったorz
とはいえ、1つ1つが大きく効いてきますよね。

例えばテキストで管理できるって意外とデカくて、資料をExcelやWordなどで書いてしまうと編集前後で差分が分かりづらくなります。と言いますか、もはや追えません。

テキストでも見やすいも大きいですよね。
例えば議事録なども書き手によって記述ルールがバラバラだと見づらいですよね。
共通のルールが決まっているので、みんなそこに合わせるだけでよいのです。
書き方を考えるなどのコストも不要です。

つまりWordでできることは大抵MarkdownでもできるからMarkdown使ってってことです。