はじめに
春から新卒エンジニアとして働き始め、意外と大事だなと思ったのはMarkdown記法を使いこなす能力です。新人のうちから、社内ブログを書いたり、チームのConfluenceにドキュメントを残したりなど、求められる機会がかなりありました。
実際、このQiitaの記事もMarkdown記法で作成しています。何かしらのドキュメントを書こうとすると必ずと言っていいほどどこかでMarkdown記法に触れるのではないでしょうか。
そこで今回はMarkdown記法について改めて調べ、備忘録としてまとめようと思います。
かなり初歩的なことからまとめるので参考になれば幸いです。
Markdown記法とは?
そもそもMarkdown記法とは何なのでしょうか。
Markdown(マークダウン)記法とは、文章に簡単な記号を付けることで、見出し・箇条書き・リンク・コードなどを表現できる書き方です。テキストを簡単に装飾されたHTML文書に変換することができる軽量マークアップ言語(データの意味や構造をコンピュータに示す言語)です。
他の言語よりも特別なソフトなどを必要とせず、メモ帳などで記号を添えるだけで簡単に記事形式で表示させることができます。
見出し
見出しを作る場合は、文章の先頭に#を付けます。#の数で大きさが変わります。
# 見出し1
## 見出し2
### 見出し3
階層構造で記事を作成するときなどMarkdown記法の中でも使用頻度の高いものだと思います。これができるだけでもただのtxtよりかなり見やすいものになりますね。
箇条書き
箇条書きがしたいときは、文章の先頭に-をつけます。
- にんじん
- じゃがいも
- たまねぎ
- にんじん
- じゃがいも
- たまねぎ
番号を付けた箇条書きの場合は、数字.のように記述します。
1. 野菜を切る
2. 切った野菜を炒める
3. 水とルーを加える
- 野菜を切る
- 切った野菜を炒める
- 水とルーを加える
改行すると次の・や番号が入力されるので続けて記述するのが簡単になります。
太字 ・ 斜体 ・ 訂正線
WordやPowerPointなどでよく目にするものですね。文章を強調したりするときに便利です。
太字
太字は**または__で先頭と末尾を囲うことで表せます。
文章の中で**ここを強調**する。
文章の中で __ここを強調__ する。
文章の中でここを強調する。
文章の中で ここを強調 する。
注意点として、**の方はそのまま使えますが、__の方は半角スペースが無いと太字になりません。
斜体
斜体は*または_で先頭と末尾を囲うことで表せます。
文章の中で*ここを斜体*にする。
文章の中で _ここを斜体_ にする。
文章の中でここを斜体にする。
文章の中で ここを斜体 にする。
太字と似ていますが、こちらは記号を1つずつ使用します。
訂正線
訂正線は~~で先頭と末尾を囲うことで表せます。
文章の中で~~ここに訂正線~~を引く。
文章の中でここに訂正線を引く。
文章を完全に削除するのではなく、修正前の内容を残したまま訂正したことを表したい場合などに使用できます。
リンク
文章の中でリンクを埋め込みたいときは[表示する文字](URL)のように表します。
[筆者のxアカウント](https://x.com/lieMoon_K)
コード
文章の中に短いコードやコマンドを書く場合は、バッククォート`で囲みます。
改行するときは`Enter`を押します。
改行するときはEnterを押します。
複数行に渡るような長いコードを記述する場合は、``` で囲みます。
```
if(true){
return true;
}
```
if(true){
return true;
}
ちなみに、`を囲うときは`` ` ``のように記述します。
水平線
---を記述すると、文章の区切りとなる水平線を表示できます。
---
長い記事を内容ごとに区切りたいときなどに使用できます。
表
複数の情報を整理して表示したいときは、|と-を組み合わせることで表を作成できます。
| 食材 | 個数 |
| --- | --- |
| にんじん | 1本 |
| じゃがいも | 2個 |
| たまねぎ | 1個 |
| 食材 | 個数 |
|---|---|
| にんじん | 1本 |
| じゃがいも | 2個 |
| たまねぎ | 1個 |
|でそれぞれの列を区切り、2行目の---で見出しとなる行と内容を区切ります。ここで使われている---は、先ほど紹介した水平線ではなく、表の見出しを指定するためのものです。
表を作成するときは、それぞれの行で列の数を合わせる必要があります。例えば、以下のように見出しが2列なのに---が3つある場合、正しく表として表示されません。
| 食材 | 個数 |
| --- | --- | --- |
| にんじん | 1本 |
また、:を付けることで、列ごとに文字の位置を指定することもできます。
| 左寄せ | 中央寄せ | 右寄せ |
| :--- | :---: | ---: |
| 左 | 中央 | 右 |
| 左寄せ | 中央寄せ | 右寄せ |
|---|---|---|
| 左 | 中央 | 右 |
:---で左寄せ、:---:で中央寄せ、---:で右寄せになります。
比較する情報が多い場合や、複数の項目を一覧にしてまとめたい場合などに便利な記法です。
さいごに
今回紹介したものだけで十分見やすいドキュメントを作成できると思いますが、Markdown記法は奥が深く、紹介しきれなかった書き方もまだまだあります。
もし興味を持ったなら、より詳しく調べてみるのもいいかもしれません。
必要最低限に絞って書いたのですが、これだけの量を書くのにもかなり時間がかかってしまいました。読んでくださる方がどれくらいいるのか分かりませんが、何かの参考や興味を持つきっかけとなれば幸いです。(文章中の筆者のxアカウントですが、フォロー頂ければ返しますのでお気軽にどうぞよろしくお願いいたします。)
