はじめに
NGS解析のコマンドを記事にまとめるにあたり記載方法はどうしたらいいんだろうか？という壁にぶつかりました。
今回はNGS解析やそれに関連するブログなどで良く使用されているマークダウン記法に関して簡単にまとめようと思います。
マークアップ・マークダウン記法とは？
マークアップとは、文章の論理的な構造や修飾情報に関する指定を文章とあわせてテキストファイルに記述するための言語のことです。代表的な例は「HTML (HyperText Markup Language) 」や「XML (eXtensible Markup Language)」などです。
マークアップ言語はテキストエディタを使って閲覧・編集でき、文章の一部を「タグ」と呼ばれる特定の文字列で囲むことで文書化するものです。
以下はHTMLの例です。
<!DOCTYPE html> <html> <head> <meta charset="UTF-8"> <title>記事のタイトル</title> <head/> <body> <header>ヘッダーを表示するためのタグで、サイトロゴやメニューを表示</header> <footer>サイトの最下部に位置するタグ</footer> <h1>「h+番号」で見出しを指定</h1> <p>文書内に段落を作るためのタグ</p> <div>：区分（Division）タグで、囲んだ文章をグループ化する</div> <br>改行（Break）タグです。※閉じタグは不要 <img>…画像を挿入するためのタグです。※閉じタグは不要 </body> </html>
上記の様にマークアップは記述や種類が多く、扱うには専門的な知識が必要です。初心者にはなかなかハードルが高いように感じます。
次にマークダウンとはHTMLなどのマークアップ言語を簡略化し、シンプルな書き方で文書構造を明示できる軽量マークアップ言語のことです。記法も少なくシンプルなため覚えれば簡単に扱うことができます。
以下に初歩的な記述例をまとめます。
1.見出し
上のような見出しを作りたい場合は、文章の前に##を入れると見出しのような表示にすることができる。 付ける個数によって大きさが変わります。
例 #見出し１ ##見出し２ ###見出し３ ####見出し４ #####見出し５
表記
見出し１
見出し２
見出し３
見出し４
見出し５
2.改行
改行したい文章の全文の最後に半角スペースを2つ入れて改行する。改行を入れないと文章は続けて表記される。
例1：次の文章を改行したい。(半角スペース)(半角スペース) この場合は改行されない。
例2：次の文章を改行したい。(半角スペース)(半角スペース) (改行)
この場合は改行されて表示される。
表記
例1：次の文章を改行したいしたい。 この場合は改行されない。
例2：次の文章を改行したい。
この場合は改行されて表示される。
3.コードブロック
コードブロック化したい領域の前後の行を``` (バッククオート3つ)で挟む
``` こんな感じで挟む。(コードブロックの中で```を使用したい場合は前にスペースなどを入れると表示できる) ```
4.文章中のコードブロックを入れる
文章中に短いブロックを入れたい場合は文字の前後を ` (バッククオート)で挟む
例：`ブロック`にしたい文章を挟むと以下の様に表示される。
表記：ブロックにしたい文章を挟む
5.文字を強調する
文章中の文字を強調したい場合は * (アスタリスク1つ) で囲む、強く強調したい場合は** (アスタリスク2つ)で囲む。
例：この発見は特に*重要*である。 例：この発見は特に**重要**である。
この発見は特に重要である。
表記：こ発見は特に重要である。
6.水平線を引く
水平線を引いて区切りを作りたい場合はその部分にアンダーバーを3つ入力する。
例：この文章の下に水平線を引く ___
表記：この文章の下に水平線を引く
7.リンクを挿入する
参考にしたWebサイトなどのURLを挿入したい場合は、以下の複数の方法があります。
1. テキストにリンクを直接埋め込む場合は、[ ]で囲みます。
[https://www.google.com]
2.リンクを張りつつURLを表示させる場合は< >で囲みます。
<https://www.google.com>
表示 : https://www.google.com
3."Google"というテキストを表示し、クリックするとリンク先に飛ぶようにする場合は [表示させたい文字](URL)の形式で書きます。
例 : [Google](https://www.google.com)
表示 : Google
以上の様な覚え書きを随時更新していこうと思います。
