はじめに
マークダウン記法とは、プログラミングスキルなどがなくても、HTMLのような文字修飾を簡単に使えるものです。GithubなどITエンジニア関連のサイトなどでよく使われているらしいです。
このQiitaのサイトも、マークダウン記法を使って書いています。
1.文字の書き方
基本的な文章はただ記述するだけで書くことができます。
しかし、連続で改行したい時、エディーター上で改行をしても1行分しか実際の表示は改行されません。その場合、<br>と入力することで改行が可能です。
例えば、以下のような書き方だと、改行が1回分しかなされていない。
あいうえお
かきくけこ
あいうえお
かきくけこ
<br>を使うことで強制的に改行することができる。
あいうえお<br><br>
かきくけこ
あいうえお
かきくけこ
2.見出し
文字を大きく太く表示することができます。1~6個のシャープ(#)の後ろに半角スペースを入れると、簡単に書けます。
# 見出し1
## 見出し2
### 見出し3
#### 見出し4
見出し1
見出し2
見出し3
見出し4
3.斜体
アスタリスク(*)またはアンダーバー(_)で文字を囲むと斜体になります。日本語は斜めにならない場合もあります。Qiitaだとなりません。
普通の文字 _ABCdefg123_ *ABCdefg123*
*日本語は無理* _日本語は無理_
普通の文字 ABCdefg123 ABCdefg123
日本語は無理 日本語は無理
4.太字
アスタリスク(*)またはアンダーバー(_)を2個で囲むと太字になります。日本語も太字になります。
普通の文字 **日本語の太字** __日本語の太字__
普通の文字 日本語の太字 日本語の太字
斜体と太字は組み合わせることもできます。
___ABCdefg123___ ***ABCdefg123***
ABCdefg123 ABCdefg123
5.取り消し線
チルダ(~)2個で文字を囲むことで取り消し線を表示できます。
~~取り消し線~~
取り消し線
6.箇条書きリスト
ハイフン(-)・プラス(+)・アスタリスク(*)のいずれかを使い、後ろに半角スペースがあることで箇条書きリストを作ることができます。
また、一番はじめにスペースかTabを入れると階層を深くすることができます。
- リスト1-1
- リスト1-2
- リスト2-1
- リスト2-2
- リスト3-1
- リスト2-3
- リスト1-3
- リスト1-1
- リスト1-2
- リスト2-1
- リスト2-2
- リスト3-1
- リスト2-3
- リスト1-3
7.番号付きリスト
1. の形で書くと番号付きのリストが作れます。
また、一番はじめにスペースかTabを入れると階層を深くすることができます。
1. リスト one
1. リスト two
1. リスト three
1. リスト four
1. リスト five
1. リスト six
1. リスト seven
- リスト one
- リスト two
- リスト three
- リスト four
- リスト five
- リスト six
- リスト seven
もちろん、1.じゃなく2.などでも大丈夫で、番号がバラバラでもちゃんと順番通りになります。
1. リスト one
25. リスト two
3. リスト three
5. リスト four
8. リスト five
666. リスト six
35. リスト seven
- リスト one
- リスト two
- リスト three
- リスト four
- リスト five
- リスト six
- リスト seven
8.引用
大なり(>)を文の初めに入れて、後ろに半角スペースを入れると、引用の表示になります。
> あああああ
> いいいいい
>> ううううう
>> えええええ
> おおおお
あああああ
いいいいいううううう
えええええ
おおおお
9.インラインコード
バッククォート( ` )で文字を囲むことでコード表示にできます。
次のコードを実行してください。`git push`
次のコードを実行してください。git push
10.インデント付きコードブロック
インデント付きコードブロックとは、コードを書くとき用に使える表示のことで、整形済みテキストともいいます。
半角スペース4つか、Tabを文頭に書くことで表示できます。
あいうえお12345
# あああ
- いいい
あいうえお12345
# あああ
- いいい
11.フェンス付きコードブロック
コードブロックは、チルダ(~)か、バッククォート( ` )を文頭と文末に書くことでも表示でき、こちらのほうがオーソドックスな書き方のように思います。
~~~
チルダでコードブロック
~~~
チルダでコードブロック
```
バッククォートでコードブロック
```
バッククォートでコードブロック
さらに、この書き方では、インデント付きコードブロックと違い、言語を指定したり、内容を補足したりできます。
チルダ(~)か、バッククォート( ` )を3つ書いた後に、言語:説明 の形で表示できます。
```Python:コード例
print("Hello,world!")
```
print("Hello,world!")
言語指定すると、コードブロック内の文字に色がつき見えやすくできます。
def greet(name):
print(f"Hello, {name}!")
greet("Godotユーザー")
def greet(name):
print(f"Hello, {name}!")
greet("Tanaka")
12.表
バーティカルバー(|)で、表を簡単に作る事ができます。
1行目は項目名、2行目はハイフン(-)が必須。3行目以降はデータを入れていけます。
|type_a|type_b|type_c|
|---|---|---|
|apple|banana|melon|
|100yen|300yen|1000yen|
|☆★★★★(4.1 / 5)|☆☆★★★(3.4 / 5)|★★★★★(4.8 / 5)|
| type_a | type_b | type_c |
|---|---|---|
| apple | banana | melon |
| 100yen | 300yen | 1000yen |
| ☆★★★★(4.1 / 5) | ☆☆★★★(3.4 / 5) | ★★★★★(4.8 / 5) |
また、2行目でコロン(:)をうまく使うと、左寄せ・右寄せにできます。
|左寄せ|中央|右寄せ|
|:--|:-:|--:|
|left|center|right|
|←←←←←|○|→→→→→|
| 左寄せ | 中央 | 右寄せ |
|---|---|---|
| left | center | right |
| ←←←←← | ○ | →→→→→ |
13.水平線
アスタリスク(*)やアンダーバー(_)、ハイフン(-)を3つ以上連続で書くことで水平線を表示できます。
***
___
---
14.リンク
[表示文字][リンク]でクリックできるハイパーリンクを作成します。
[Youtube](https://www.youtube.com)
15.画像
で画像を表示します。
Githubなど一部ではドラッグ・アンド・ドロップやファイル追加ボタンで画像を挿入することもできます。

16.埋め込みリンク
URLをそのまま貼り付けると、一部のマークダウンでは自動的に埋め込みリンクのように表示されます。
https://www.youtube.com
17.チェックボックス
箇条書きリストの文字の前に括弧[ ]を書くことでチェックボックスを表示できます。
また、括弧[ ]の中にxを入れると、チェックされた状態にすることもできます。
- [ ] aaa
- [ ] bbb
- [x] ccc
- aaa
- bbb
- ccc
18.注釈
[^参照名]で本文中に注釈を作り、[^参照名]: 説明で、サイト下に注釈が表示されます。
~~地球は平面である。~~[^1]
地球は球体である。[^2]
[^1]: 注釈1の参照先です。
[^2]: 注釈2の参照先です。
おわりに
マークダウンできれいな文章を書けると、GithubのREADMEやissueなど、他人との共同作業の際に情報伝達効率が上がると思います。ぜひ皆さん使えるようにしていきましょう。
