[読書のススメ]Markdownライティング入門でMarkdownを身近なものにしてみる

技術書典にて購入したMarkdownライティング入門の読了記録です。手に取るかどうか迷っている方の参考になれば幸いです。
2019.05.17

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

はじめに

WordPressや、Github、はてなブログ等、markdownで効率的に原稿を書くことが出来るスペースは周りに多く存在しています。

ただ、記法があまり知られていないことや、実際に使ってみても上手く反映されないなど、普段から使うには若干壁を感じてしまうことも確かです。

Markdownについてより知りたい人や、Markdownに壁を感じている方への導入本としても有効だと思われる、Markdownの使い方・小技・歴史について一冊にまとめられた「Markdownライティング入門」を読んでみました。

Markdownライティング入門について

Markdownは幅広い用途で使われていますが、その中でも日本国内にてある程度利用者がいると思われるWebサービスやエディタに沿ってまとめられています。

Markdownライティング入門 プレーンテキストで気楽に書こう! (技術の泉シリーズ(NextPublishing)) | 藤原 惟 | 工学 | Kindleストア | Amazon

技術書典にて紙版を購入しましたが、電子書籍版も勿論存在します。

技術書典6を宝探し感覚で巡ってきた記録 #技術書典

当書における対象のMarkdownについて

事実上の標準とされる、CommonMarkに準拠しています。

その中から独自に以下の定義を行うことで、少しでも書き進められるようにする構成となっています。

ミニマムMarkdown
「プレーンテキストでかく」「段落は空行で区切る」の2原則をベース
きほんのMarkdown
「どのアプリでも無難に使えるMarkdown」。ミニマムMarkdownと組み合わせて使う

初めてMarkdownに触れる場合

プレビュー機能のついたアプリを使って、Markdownのプレビューを通してイメージしやすくすることにより慣らす方法が挙げられています。

Windows
MarkdownPad
Mac
MacDown

実際の業務にてmarkdownを使う時と勝手が異なる可能性は十分にありますが、Markdownに不慣れな時は当書の上記アプリの使い方説明にそって始めるとわかりやすいと思います。

実践でのMarkdown

執筆時の手続き、及びはてなブログやWordPressを用いてのMarkdown利用方について触れられています。

Markdownでの執筆は、最初から記法をふんだんに交えるわけではなく、ある程度文章を書き出した上での整形とするほうが無難です。当書では実際の手順を交えて解説しています。

整形に使うアプリは人それぞれですが、紙面ではTyporaが推奨されています。Mac/Windows/Linuxで利用可能です。

WordPressでのMarkdown

DevIOで最初にエントリーを書くときにハマりましたが、ビジュアルとテキストでMarkdownの扱いが異なります。ビジュアルの場合、Markdownがその場で変換されて残らないため、自身でどんなMarkdownを使ったのか覚えておく必要があります。

VimWordPressの場合は、投稿時にpython-markdownベースでmarkdownからHTMLタグへと変換された上で、テキストモードにて原稿が収まります。そのため、WordPress上でmarkdownでの整形は行いません。

Markdownの歴史

現在多く利用されている以下のMarkdownについて解説されています。読んでいるうちに、正直一本化してほしいとも思えるのですが、やはり用途に応じて個別発展していく仕組みなのだなと感じざるを得ません。

  • Github Flavored Markdown
  • MultiMarkdown
  • はてなブログのMarkdownモード
  • R Markdown
  • CommonMark
  • PHP Markdown Extra
  • Redcarpet

私が当ブログでエントリーを書く際にはCommonMarkとPHP Markdown Extraの一部を利用しています。

なお、比較ツールとしてBabelmarkが触れられています。

まとめ

基本的な記法は共通なのですが、使うシーンによって色々と分化していくものだと実感する一冊です。

Markdownは特にエンジニアがgithubを使う上で回避し難い代物です。一度慣れてしまえばタイプ数も少なくなり、且つHTMLタグでの整形の手間からの開放されるため、思い切って慣れてしまうことをオススメします。