Markdown記法のチートシート
Markdownファイルの拡張子
Markdownファイルの拡張子は「.md
」
基本構文一覧
見出し(ヘッダー)
#
のあとにスペースを開け文字を記載すると見出しとなります。
#
の数で見出しのレベルを表すことができます。
# 見出し1
## 見出し2
### 見出し3
#### 見出し4
##### 見出し5
###### 見出し6
![見出し](/images/1705348512610.png)
段落
文章と文章の間に空行を挟むと段落になります。
段落1
段落2
![段落](/images/1705351596408.png)
改行
Markdownで改行しても、表示結果は改行されません。
改行するには行末に半角スペースを2個入力します。(※␣
は半角スペース)
行末にスペースなし
行末にスペースなし
行末にスペース2個␣␣
行末にスペース2個
![改行](/images/1705350077730.png)
テキストスタイル
イタリック(斜体)は*
、ボールド(太字)は**
、イタリックボールドは***
で囲みます。
*italic*
**bold**
***italic bold***
![テキストスタイル](/images/1705348736350.png)
番号付きリスト
1.
と数字の後にドットを記載し、スペースを開け文字を記載します。
インデントすると入れ子になります。
1. アイテム1
1. アイテム2
1. サブアイテム1
1. サブアイテム2
1. アイテム3
![番号付きリスト](/images/1705349176233.png)
番号なしリスト
-
、*
、+
のあとにスペースを開け文字を記載します。
インデントすると入れ子になります。
- アイテム1
- アイテム2
- サブアイテム1
- サブアイテム2
- アイテム3
![番号なしリスト](/images/1705349527091.png)
引用
>
のあとにスペースを開け文字を記載すると引用となります。
通常の文章
> 引用の文章
![引用](/images/1705389889440.png)
インラインコード
バッククオート(`
)で囲むとインラインコードとなります。
Pythonで`print("Hello World")`を実行すると、
コンソールに`Hello World`を出力します。
![インラインコード](/images/1705390393808.png)
リンク
URLのみの場合は<>
で囲みます。
テキストを付ける場合は[テキスト](URL)
と記載します。
<http://example.com/>
[例](http://example.com/)
![リンク](/images/1705390830355.png)
画像
![altテキスト](画像のURL)
と記載します。
![ロゴ](https://stysk.com/img/logo.png)
![画像](/images/1705391381933.png)
水平線
空行のあとに---
と記載すると水平線が挿入されます。
文章1
---
文章2
![水平線](/images/1705391594054.png)
拡張構文一覧
拡張構文はMarkdownツールによってサポートされない場合があります。
テーブル
パイプ(|
)とハイフン(-
)で区切ります。
ハイフンの左、両端、右にコロン(:
)を追加することで、セル内の文字が左揃え、中央揃え、右揃えとなります。
| Header1 | Header2 | Header3 |
| :------ | :-----: | ------: |
| left | center | right |
![テーブル](/images/1705392177035.png)
コードブロック
バッククオート3つ(```
)で囲みます。
```
#include <stdio.h>
int main() {
printf("Hello World\n");
return 0;
}
```
![コードブロック](/images/1705392465214.png)
定義リスト
用語の次の行に:
とスペースを開け説明を記載します。
りんご
: 赤くて美味しい果物
バナナ
: 黄色くて甘い果物
みかん
: 橙色で酸味がある果物
![定義リスト](/images/1705392940886.png)
打消し線
~~
で囲みます。
この文は~~打消し線が入った~~サンプルです。
![打消し線](/images/1705393121597.png)
タスクリスト
- [ ]
のあとにスペースを開け文字を記載します。
チェックを入れる場合は- [x]
と記載します。
やるべきことリスト
- [ ] 洗濯する
- [x] 買い物に行く
- [ ] 資料を作成する
![タスクリスト](/images/1705393442341.png)
その他
Markdownのコメント
Markdownにコメント構文は存在しないため、HTMLのコメント構文を使用します。
<!-- コメントなので表示されない -->
表示される
![コメント](/images/1705393740866.png)
Markdownのエスケープ
以下の文字を文章内で使用する場合は、文字の前にバックスラッシュ(\
)を追加します。
文字 | 内容 |
---|---|
\ |
バックスラッシュ |
* |
アスタリスク |
_ |
アンダースコア |
{ } |
波括弧 |
[ ] |
角括弧 |
< > |
山括弧 |
( ) |
丸括弧 |
# |
シャープ |
+ |
プラス |
- |
マイナス |
. |
ドット |
! |
エクスクラメーション |
| |
パイプ |
` |
バッククオート |
\#を表示する
![エスケープ](/images/1705393862456.png)
インラインコード内のバッククオートエスケープ
インラインコード内でバッククオートを表示する場合は、バッククオート2個で囲みます。
インラインコード内に`` `code` ``を書く。
![インラインコード内のバッククオートエスケープ](/images/1705394006328.png)
コードブロック内のバッククオートエスケープ
コードブロック内でバッククオート3個を表示する場合は、バッククオート4個で囲みます。
````
コードブロック内に
```
code
```
を書く
````
![コードブロック内のバッククオートエスケープ](/images/1705394152640.png)