マークダウン記法の基本的な使い方

今日は、設計書やドキュメントを記述する際に使用するマークダウン記法についてまとめます。

見出し

#を頭につけることで見出しとなる。
#の数が多いほど子項目となる。

＊記述例

# 見出し1

## 見出し2

### 見出し3

#### 見出し4

##### 見出し5

＊見え方

見出し1

見出し2

見出し3

見出し4

見出し5

---

文字装飾

斜体

_で斜体にしたい文字を挟む

＊記述例

_斜体_ 
_shatai_ 

＊見え方
斜体
shatai

太字

**で太字にしたい文字を挟む

＊記述例

**太字**
**futoji**

＊見え方
太字
futoji

強調斜体

**_と_**で文字を挟む

＊記述例

**_強調太字_**
**_kyocho-futoji_**

＊見え方
強調太字
kyocho-futoji

取消線

~~で文字を挟む

＊記述例

~~取消~~
~~torikeshi~~

＊見え方
取消
torikeshi

HTMLタグを使用した文字装飾

マークダウンの中でHTMLタグを記述することもできる。

＊記述例

<u>uタグで下線を引いてみた例</u>

＊見え方
uタグで下線を引いてみた例

---

リスト

箇条書きリスト

リストは-もしくは+で記述可能。入れ子にすることもできる。

＊記述例

-   リスト1
-   リスト2
    +  リスト2.1
    +  リスト2.2
        -   リスト2.2.1
    +  リスト2.3
-   リスト3

＊見え方

• リスト1
• リスト2
  • リスト2.1
  • リスト2.2
    • リスト2.2.1
  • リスト2.3
• リスト3

番号付きリスト

1.で番号付きリストも作成することができる。

＊記述例

1. 番号付きリスト
1. 番号付きリスト
    1.  番号付きリスト
    1.  番号付きリスト
        1.  番号付きリスト
    1.  番号付きリスト
1.  番号付きリスト

＊見え方

1. 番号付きリスト
2. 番号付きリスト
   1. 番号付きリスト
   2. 番号付きリスト
      1. 番号付きリスト
   3. 番号付きリスト
3. 番号付きリスト

---

水平線

水平線は***や---で引くことができる。

＊記述例

* * *
---

＊見え方

---

---

ソースコード

バッククォート3つ（```）でコードを囲む。

```javaのように、開始のバッククォートの末尾に言語を記載することで、 色付けされて見やすいコードで表示される。

/**
* 引数で受け取った文字列を標準出力する。<br>
*
* @param str
*            出力する文字列
*/
public void doSomething(String str) {
    System.out.println(str);
}

表

＊記述例

| 社員ID | 名前  | mail     |
| ---- | --- | -------- |
| 001  | aaa | hoge@com |
| 001  | aaa | hoge@com |
| 001  | aaa | hoge@com |
| 001  | aaa | hoge@com |

＊見え方

社員ID	名前	mail
001	aaa	hoge@com
001	aaa	hoge@com
001	aaa	hoge@com
001	aaa	hoge@com

マークダウンを便利に書けるツールバーがついたエディタが世の中にはたくさんあって、
覚えていなくても書けてしまうけれど、最低限上記のやつだけは忘れないようにしたい。。。