Markdown
Markdownとは
Markdownは文書を記述するための軽量マークアップ言語。その書きやすさと読みやすさから、GitHubやQiitaなどのWebサービスでも採用されている。同じくマークアップ言語であるHTMLなどへの変換も簡単にできる。
よく使うMarkdown記法
見出し
「#」を使うと見出しを表現できる。また、「#」の数によって見出しの階層を制御できる。
# 見出し1
見出し1の本文
## 見出し2
見出し2の本文
### 見出し3
見出し3の本文
▼プレビュー
改行
半角スペース2つを使うと改行できる。下の例ではわかりにくいが、一行目の文末に半角スペース2つが入力されていて、これによって改行ができる。
文末に半角スペース2つを入力すると改行できる→
改行できた
▼プレビュー
リスト
ハイフンを使うと箇条書きを表示できる。半角スペース2つと合わせて使うと階層を制御できる。
- リスト1
- 項目1
- 項目2
- 項目3
- リスト2
- 項目1
▼プレビュー
番号付きリスト
「1.」のように先頭に番号を付けると、番号付きの箇条書きを表示できる。インデントを使うと階層を制御できる。
1. リスト1
1. 項目1
1. 項目2
1. 項目3
1. リスト2
1. 項目1
▼プレビュー
表(テーブル)
パイプとハイフンを使うと表(テーブル)を表現できる。ハイフンの左右にコロンを付けると右寄せ、中央揃え、左寄せを指定できる。
| Col1 | Col2 | Col3 |
|---:| :---: | :--- |
| 右寄せ | 中央揃え | 左寄せ |
| xxxxxxxxxx | xxxxxxxxxx | xxxxxxxxxx |
▼プレビュー
強調、太文字
アスタリスクを使うと文字を太く強調できる。
アスタリスクを使うと**強調**できる
▼プレビュー
取り消し線
チルダを使うと取り消し線を表示できる。
チルダを使うと~~取り消し線~~を表示できる
リンク
角括弧と丸括弧を組み合わせるとリンクを表示できる。
[Albert Einstein](https://en.wikipedia.org/wiki/Albert_Einstein)はドイツ生まれの理論物理学者。
▼プレビュー
画像
「!」と角括弧と丸括弧を組み合わせると画像を埋め込むことができる。
![](https://upload.wikimedia.org/wikipedia/en/8/86/Einstein_tongue.jpg)
▼プレビュー
ソースコード
バッククォート3つを使うとソースコードを表現できる。またバッククォートの後にpythonなどのプログラミング言語名を入力すると言語に応じてソースコードを色付けできる。
```python
import numpy as np
def add(a, b):
"""
a:int
b:int
"""
return a + b
if __name__ == '__main__':
a = np.random.rand() # 乱数1
b = np.random.rand() # 乱数2
result = add(a,b)
print(result)
```
▼プレビュー
引用
「>」を使うと引用を表現できる。
> Markdown(マークダウン)は、文書を記述するための軽量マークアップ言語のひとつである。 本来はプレーンテキスト形式で手軽に書いた文書からHTMLを生成するために開発されたものである。 しかし、現在ではHTMLのほかパワーポイント形式やLaTeX形式のファイルへ変換するソフトウェア(コンバータ)も開発されている。
>
> Wikipediaより引用
▼プレビュー
VSCodeでMarkdownを使ってみる
1. VSCodeを開いて、拡張子を「md」としてファイルを作成する
2. 右上のプレビューボタンを押して、プレビュー画面を横に表示する
3. マークダウン記法を書いて、プレビューを確認する