自分用のチートシートです。
VSCodeでのマークダウン記法の基本的なところを簡単にまとめてみました。
VSCodeで編集してからQiitaにコピペしたため、Qiitaで上手く表示されるように微調整するのが大変でした。
見出し
文頭に#をつけることで見出しになる。
#と文字の間に半角スペースを入れる。
#の数を増やすと見出しが小さくなる(#の数は最大6個)。
- 書き方
# h1
## h2
### h3
#### h4
##### h5
###### h6
####### h7
- 結果
h1
h2
h3
h4
h5
h6
####### h7
強調表現
*
または_
で文字列を囲むことで強調表現ができる。
*
,_
で斜体。
**
,__
で太字。
***
,___
で斜体&太字。
- 書き方
*Markdown*
**Markdown**
***Markdown***
- 結果
Markdown
Markdown
Markdown
打ち消し線
~~
で文字を囲うことで囲った文字に打ち消し線を引くことができる。
- 書き方
打ち消し線を使うには ~~ で囲む。 ~~打ち消し~~
- 結果
打ち消し線を使うには ~~ で囲む。
打ち消し
水平線
_
,*
,-
のいずれかを3つ以上連続して記入することで水平線を表示することができる。
- 書き方
___
***
テキスト
---
* * *
- 結果
テキスト
段落
空行を挟むと段落ができる。
- 書き方
空行を挟むと
(改行)
段落ができる。
- 結果
空行を挟むと
段落ができる。
改行
ただの改行では改行されない。
文末に半角スペースを2つ入力して改行する。
- 書き方
文末で半角スペースを
2つ入力すると改行される。
文末で半角スペースを (半角スペース2つ)
2つ入力すると改行される。
- 結果
文末で半角スペースを2つ入力すると改行される。
文末で半角スペースを
2つ入力すると改行される。
リスト
文頭に*
,+
,-
のいずれかを挿入するとリストになる。
インデントを使ってネストすることも可能。
記号と文の間にスペースが必要。
- 書き方
- text1
- text2
- text3
- text3.1
- text3.2
- text4
- 結果
- text1
- text2
- text3
- text3.1
- text3.2
- text4
番号付きリスト
文頭に数字.
を入れると番号付きリストになる。
自動でカウントされるためどんな値を入れても番号順に表示される。
- 書き方
1. text1
1. text2
1. text3
1. text3.1
1. text3.2
1. text4
- 結果
- text1
- text2
- text3
- text3.1
- text3.2
- text4
インライン表示
`
か``
で囲むとインライン表示になる。
- 書き方
`インライン`表示
``インライン``表示
- 結果
インライン
表示
インライン
表示
コードブロック
```
で囲むとコードブロックになる。
言語の指定をするとシンタックスハイライトが使用できる。
`
の数は3つ以上。ただし、対応する物は同じ数にする。
- 書き方
```
public class Sample {
public static void main(String[] args){
System.out.println("Hello World");
}
}
```
``````Java
public class Sample {
public static void main(String[] args){
System.out.println("Hello World");
}
}
``````
- 結果
- 言語指定なし
public class Sample { public static void main(String[] args){ System.out.println("Hello World"); } }
- 言語指定あり
public class Sample { public static void main(String[] args){ System.out.println("Hello World"); } }
引用
>
を文頭に記入すると引用になる。
>>
というように複数並べてネストができる。
引用の中でマークダウンを使うことも可能。
- 書き方
>引用
>>**引用**
>>>引用
- 結果
引用
引用
引用
リンクの挿入
[タイトル](URL)
でリンクの挿入ができる。
- 書き方
[google](https://www.google.co.jp/)
- 結果
画像の挿入
![代替テキスト](URL "タイトル")
で画像の挿入ができる。
- 書き方
![google](https://www.google.com/logos/doodles/2020/stay-and-play-at-home-with-popular-past-google-doodles-pac-man-2010-6753651837108775.2-2xa.gif "google ドーブル")
- 結果
テーブル
|
と-
を使ってテーブルを作成することができる。
また、テキストのアライメントを指定することができる。
---:
で右揃え。
:---:
で中央揃え。
:---
または---
で左揃え。
-
の数は自由。
- 書き方
| head1 | head2 | head3 |
| :---- | :---: | ----: |← アライメントの指定
| body1 | body2 | body3 |
| body4 | body5 | body6 |
- 結果
head1 head2 head3 body1 body2 body3 body100 body200 body300
注釈
本文中に[^1]
や[^example]
のように記述することで注釈内容へのリンクをつけることができる。
注釈内容は、本文中に [^1]: テキスト
というように記述する。
- 書き方
テキスト1[^1]
[^1]: テキスト1の内容
テキストa[^a]
[^a]: テキストaの内容
- 結果
テキスト11
テキストa2
エスケープ
\
をMarkdownの前に挿入することで、Markdownをエスケープすることができる。
- 書き方
*Markdown*
\*Markdown*
- 結果
Markdown
*Markdown*
参照
Daring Fireball: Markdown Syntax Documentation
Qiita Markdown記法 チートシート
github Markdown記法 チートシート