マークダウンの基本的な書き方

主にGitLabで使用できるマークダウン記法について記載しています。
Qiitaでの表示はGitLabでの表示とことなる場合があります。
preview at GitLabではGitLabでの表示に近くなるようにしています。

【目的】
新人教育用にマークダウンの基礎の基礎を伝えるために書きました。
追加があれば末尾に追記していくと思います。

目次

1. 改行
2. コードの記述
3. リスト
4. チェックボックス
5. 強調・斜体・打消し

改行

半角空白2つ もしくは 改行2連続
で改行される。

■ code

md

1行目  
2行目

3行目
4行目

■ preview at GitLab
1行目
2行目

3行目 4行目

コードの記述

バッククオート1つで囲うことによって1行のソースコードを表せる
バッククオート3つ以上で囲うことで複数行のソースコードを表現できる

バッククオート3つ以上で囲う場合、最初に```md, ```jsのように言語を指定すると
各言語ごとにそれなりに見やすくなる

■ code

md

`一行コード`

```
複数行コード1  
複数行コード2
```

```js
$("input[name=name]").val()
```

■ preview at GitLab
一行コード

複数行コード1  
複数行コード2

$("input[name=name]").val()

リスト

- で箇条書きのリスト、1. で番号付きのリストが表現できる。

複数の入れ子にすることも可能
入れ子にする場合は- 1. の前に半角空白2つ記載すればいい。

1. について、複数記載時に2,3...と番号をずらさなくとも問題ない。
自動で採番してくれる

■ code

md

- リスト1
- リスト2
  - リスト2-1
  - リスト2-2
- リスト3

1. 番号付き１
1. 番号付き２
  1. 番号付き2-1 
  1. 番号付き2-2 
1. 番号付き３

■ preview at GitLab

• リスト1
• リスト2
  • リスト2-1
  • リスト2-2
• リスト3

1. 番号付き１
2. 番号付き２
   1. 番号付き2-1
   2. 番号付き2-2
3. 番号付き３

チェックボックス

順序なしリストの後ろに[ ] [x]を追加するとチェックボックスを表せる。
[ ]で未チェック、[x]でチェック済
チェック済のxは半角小文字のエックス

■ code

md

- [x] 項目１
- [x] 項目２
- [ ] 項目３

■ preview at GitLab
※GitLabではクリックでチェックを入れたり消したり出来る

• 項目１
• 項目２
• 項目３

強調・斜体・打消し

**または__で囲うと太字
*または_で囲うと斜体
~~で囲うと打消しになる

■ code

md

**太字**  
*斜体*  
*italic*  
  
__太字__  
_斜体_  
_italic_  
  
~~打ち消し~~  

■ preview at GitLab
※Qiitaでは日本語斜体はサポートされていないっぽい
太字
斜体　
italic

太字
斜体
italic

打ち消し

---

以上