Markdown(マークダウン)の書き方・プレビュー

チートシートPDF

左に書くと右にすぐ表示されるので、書き方を試しながら覚えられます。下の一覧で記法と表示を見比べることもできます。

Markdown

プレビュー

入力したデータは送信も保存もしません。悪用することも一切ありません。くわしく

Markdownの書き方一覧

左が書き方、右が実際の表示です。「試す」を押すと上のエディタに追加されます。

文字

見出し
# 大見出し
## 中見出し
### 小見出し
大見出し
中見出し
小見出し

# の数がレベル(1〜6)。# のあとに半角スペース

太字
これは **太字** です

これは 太字 です

__太字__ でも可

斜体
これは *斜体* です

これは 斜体 です

日本語は斜体が目立たないので太字がおすすめ

取り消し線
~~取り消し~~

取り消し

GitHub形式(GFM)

インラインコード
`npm install` を実行

npm install を実行

バッククォートで囲む

改行
1行目(末尾に半角スペース2つ)  
2行目

1行目(末尾に半角スペース2つ)
2行目

普通に改行しただけでは同じ段落につながる。段落を分けるなら空行を入れる

段落
1つ目の段落

2つ目の段落

1つ目の段落

2つ目の段落

空行で段落が分かれる

リスト

箇条書き
- りんご
- みかん
  - 温州みかん
  • りんご
  • みかん
    • 温州みかん

- * + のどれでも可。半角スペース2つ(または4つ)で入れ子

番号付き
1. 準備する
2. 実行する
3. 確認する
  1. 準備する
  2. 実行する
  3. 確認する

数字はすべて 1. でも自動で連番になる

チェックリスト
- [x] 完了したタスク
- [ ] 未完了のタスク
  • 完了したタスク
  • 未完了のタスク

GitHub形式(GFM)

ブロック

引用
> 引用した文章
> 2行目

引用した文章 2行目

コードブロック
```js
const msg = "hello";
console.log(msg);
```
const msg = "hello";
console.log(msg);

``` のあとに言語名を書くと色分けされる(対応サービスのみ)

水平線
---

*** でも可

表
| 名前 | 点数 |
| --- | ---: |
| 山田 | 80 |
| 佐藤 | 95 |
名前 点数
山田 80
佐藤 95

2行目の --- が必須。---: で右寄せ、:---: で中央

リンク・画像

リンク
[IT道具箱](https://example.com)

URLだけ書いても自動でリンクになるサービスが多い

画像
![アイコン](/favicon.svg)

アイコン

リンクの前に ! を付ける。( ) の中は画像のURLやファイルの場所

エスケープ
\*アスタリスクをそのまま表示\*

*アスタリスクをそのまま表示*

記号の前に \ を付けると記号として表示

Markdownが使える主なサービス

サービス使える場所ひとこと
GitHub / GitLabREADME、Issue、プルリクエスト、Wiki表・チェックリストなどの拡張(GFM)に対応
Qiita / Zenn / note技術記事・ブログ独自の拡張記法もある
Notionページの入力入力中に記法を打つと自動で書式に変わる
Backlog課題・Wikiプロジェクト設定で「Markdown」を選んだ場合
Slack / Teamsチャット基本的な記法のみ(書き方が少し違う)
VS Code などメモ・ドキュメント(.md)プレビュー機能つきのエディタが多い

Markdownは、記号を少し付けるだけで見出しや箇条書きを表せる、シンプルな書き方のルールです。 Wordのようにボタンで書式を付けなくても、キーボードだけで読みやすい文書が書けるため、エンジニアだけでなく議事録やマニュアル作りにも広く使われています。 書いたままのテキストでも読みやすいのが特長です。

Excelの表をMarkdownの表に変換したいときはExcel表をMarkdownに変換が便利です。 文字数の確認は文字数カウントをどうぞ。

よくある質問

普通に改行したのに、プレビューでつながってしまいます。

Markdownでは、1回の改行は同じ段落の続きとして扱われます。段落を分けたいときは空行を入れ、段落の中で改行したいときは行末に半角スペースを2つ入れてください。GitHubのコメントやチャットツールなど、1回の改行でそのまま改行されるサービスもあります。

Slack や Teams でも同じ書き方が使えますか?

太字・箇条書き・コードなど基本的な記法は使えますが、サービスごとに少しずつ違います。例えば Slack の太字は *太字*(アスタリスク1つ)です。表は Slack では使えません。

入力した内容は保存されますか?

保存も送信もしません。プレビューはお使いのブラウザの中だけで作っています。ページを閉じると内容は消えるので、必要な場合はコピーしておいてください。

HTMLのタグを書くとどうなりますか?

安全のため、このプレビューではHTMLのタグは実行せず、そのまま文字として表示します。GitHubなど多くのサービスでは一部のHTMLタグが使えます。

変換・計算の結果は正確さに努めていますが、すべての入力での動作を保証するものではありません。 業務で使う場合は、重要なデータは結果を確認してからご利用ください。詳しくは免責事項をご覧ください。