拡張子mdファイルとはマークダウン記法で書かれたドキュメント

ここ最近、mdあるいはmarkdownという拡張子を持ったファイルを散見する。

筆者がいるプロジェクト内でも、個々の技術者がmd(あるいはmarkdown)拡張子のファイルを記述する姿をよく見かけるようになった。

mdという謎の拡張子を持ったファイルは、マークダウン記法で記述されたドキュメントである。

筆者が実際に使ってみて感じたマークダウンの有用性についてまとめる。

マークダウンとは

マークダウンとは、文章を記述するための軽量マークアップ言語の一つ。(出典:Markdown – Wikipedia

歴史は古く、2004年に初版がリリースされたとある。

マークダウンに関する厳密な定義にまで踏み込むと、話しがややこしくなるので、簡単にHTMLの簡易版程度の認識でよろしい。

HTMLと同じように機能させることが出来るので、見た目を装飾することが可能だ。

但し、マークダウン文章の見た目を活かした表示をするためには、専用のビューアーが必要である。

マークダウンは何が便利なのか?

マークダウンを使うと、どんな利便性を得られるのかについて考察する。

文章に意味付けをし見栄えを装飾出来る

プロジェクト内の限られたメンバー向けの文章というのは、とかく殺伐として読みづらい。

殴り書きのようなメモ書きのプレーンテキストを読むのは、地味に辛い作業だったりする。

緊張感の欠けた抑揚のない見た目の文章では、大切な内容を見逃してしまうことにもなりかねない。

マークダウンで意味付けされた文章内の語句やセンテンスは、マークダウンビューアによって装飾された文章として表示されるので、洗練された読み物になる。

例えば、章・節・項で章立てされた構成にも出来るのだ。

readme.txtやreleasenote.txtの表現力が倍増する

プロジェクト内の関係者だけに向けられる文章の代表格でもある「readme.txt」や「releasenote.txt」は、プレーンテキストで記述されるのが常だった。

多くの場合、これら内部文書は適当に書かれている。

ところが、マークダウンで記述された「readme.txt」や「releasenote.txt」は、ドキュメントとしての体裁が整っていて読みやすい。

マークダウンを用いたドキュメントのおかげで、案外重要なことが記されている「readme.txt」や「releasenote.txt」に目を通さない不届きな輩も減ることだろう。

マークダウンは低い学習コストで習得できる

マークダウンで文章を記述するには、その文法を覚えなければならない。

社内向けのreadme.txtのためだけに、わざわざ新しいsyntaxを覚えるのは少々億劫ではある。

だが、HTMLとは比較にならないほど簡易なルールなので、その学習にかかるコストはとても少ない。

肥大化したHTMLやCSSの仕様を覚えられる気力があれば、マークダウンの習得は簡単だろう。

マークダウン文法

実際のマークダウンの文法は、どのようなものなのか?

マークダウンの文法については、チートシートなどとしてまとめられている情報がたくさんあるので、ここでは述べないが、下記サイトは参考になる。
Basic Syntax

マークダウンに関連するツール

マークダウンで記述された文章は、専用のビューアを使うことで、それなりの体裁のドキュメントとして表現される。

HTML文書をWEBブラウザで表示するのと同じ仕組みをイメージすれば良い。

マークダウンに関するツールとして多いのは、エディタであろう。

平易なマークダウンのために、わざわざ専用のエディターをインストールするのも大げさに感じられるが、記述した文章のイメージをリアルタイムで視認できる機能は、使ってみると大変便利だ。

筆者は、Visual Studio Codeの拡張機能の一つである「Markdown All in One」を利用している。

マークダウンは簡単で利用価値が高い

ちょっとしたメモ程度の文章を書く機会は、思いの外多いものだ。

手早く表記できるプレーンテキストだが、その代償として、読み手の注意を引き付けられないのでは本末転倒だ。

僅かな労力で、文章を理解しやすく構成できるマークダウンは、身につけて置いて損の無いスキルだと言える。

スポンサーリンク

シェアする

  • このエントリーをはてなブックマークに追加

フォローする