技術とか戦略とか

SIerで証券レガシーシステムを8年いじってからSESに転職した普通の文系SEによる技術ブログ。

マークダウン記法とは

【マークダウン記法とは】
マークダウン記法とは、簡単に言うとマークアップ記法(HTML等)を簡略化したものです。
タグを用いることなく、簡単な記法で文書の整形を行うことができます。
Wordに代表される文書作成ツールやマークアップ記法の文書よりも簡単に書くことができ、テキストファイルの文書よりも見た目を綺麗にすることができるので、近年ではReadMe等に使われることが少なくありません。
 
マークダウン記法は容易に綺麗な文書を作成できることがメリットですが、エディタやビューアを自分で用意しなければならないのが難点です。
そのため、Excel方眼紙が多様されている等、マークダウン記法が広まっていない現場だと使いにくいかもしれません。
(ただし、普通のテキストファイルとして見ても、それなりに見やすい文書にはなります)
 
【マークダウン記法の文書の作成方法】
拡張子は「.md」を用います。
文字コードUTF-8である必要があります。
文書は、シャープやアスタリスクやスペース等の記号を用いて整形します。
(当記事にも簡単なサンプルは載せますが、詳しくはWeb等で調べてみて下さい)
 
マークダウン記法の文書を作成するなら、エディタを用意する必要があります。
私はエディタにVisual Studio Codehttps://azure.microsoft.com/ja-jp/products/visual-studio-code/)を使用しています。
意味を持つ記号がハイライト表示されるだけでなく、Ctrl + Shift + v でプレビュー表示することもできます。
単純にマークダウン記法を書きやすいだけでなくプログラミングのエディタとしても有力で、IDEよりも軽量、かつ様々なプログラム言語(C系の言語、PythonJavaScript等)の構文がハイライト表示されるので、入れておくと色々便利です。
 
また、ビューアも別途用意した方が便利かもしれません。
例えば、FireFoxMarkdown Viewer(https://addons.mozilla.org/ja/firefox/addon/markdown-viewer-chrome/)をインストールすれば、FireFoxでマークダウン記法の文書を整形された状態で読むことができます。
インストール自体もワンクリックで済むので、非常に導入しやすいです。
 
【サンプル】
・test.md
# はじめに
このファイルはmdファイルのサンプルです。 
シャープ+スペースで見出しになります。 
スペースを2つ繋げると改行になります。

# usageもどき
シングルクォーテーション3つで囲われた箇所はコード表記になります。

```
hoge.exe [-b]
```

* -bオプション 
バッククォート+スペースで箇条書きになります。

Visual Studio Codeのプレビュー表示
f:id:akira2kun:20200607231816j:plain

FireFoxMarkdown Viewerでの表示
f:id:akira2kun:20200607232031j:plain