Markdownを1ページで。書くものと、表示されるもの。
Markdownは、いくつかの記号で書式を表すテキストです。このページでは、よく使うものを、書くものと表示されるものを並べて紹介します。
macOS 14以降。閲覧は無料で、編集とレビューは1回のお支払いです。
要点
Markdownは、いくつかの記号で書式を表すテキストです。見出しは#、リストは-、**bold**、`code`、[link](url)、表は| a | b |、タスクは- [ ]です。このページでは、GitHubの拡張(表、タスクリスト、コールアウト、Mermaid図、数式)を含む全要素を、書くものと表示されるものとともに並べています。
見出し、文字、改行
| 書くもの | 表示されるもの |
|---|---|
# Heading 1から###### Heading 6まで | 見出し。いちばん大きいものから小さいものまで。#の後ろにスペースを入れます。 |
**bold** | 太字 |
*italic*または_italic_ | 斜体 |
~~strikethrough~~ | |
> a quote | 字下げされた引用。引用は> >で入れ子にできます。 |
単独の行に--- | 水平線。上に空行を空けておきます。 |
\*not italic\* | バックスラッシュを付けると、記号がそのまま表示されます。 |
空行を入れると新しい段落になります。段落の中の改行1つは無視され、行はつながります。改行を強制するには、行末にスペース2つか、バックスラッシュを付けます。
リスト、タスクリスト、表
- Milk
- Bread
- Rye
- Wheat
1. Open the folder
2. Pick a file
- [x] Write the plan
- [ ] Review it
箇条書きは、各行を-、*、+で始めます。入れ子にするには、スペース2つか4つで字下げします。番号付きリストは、最初の番号さえ合っていれば足ります。タスクリストは、前に[ ]か[x]を付けた箇条書きで、チェックボックスとして表示されます。
| Plan | Price | Users |
|-------|------:|:-----:|
| Free | $0 | 1 |
| Team | $12 | 10 |
表では、2行目が見出しと本体を区切ります。:---は列を左揃え、---:は右揃え、:---:は中央揃えにします。テキストの上で列がそろっている必要はありません。セルの中に|を入れるには、\|と書きます。
コード
インラインコードは、バッククォート1つで囲みます。ブロックは、前後の行にバッククォート3つを置き、開く側の後ろに言語名を書くと、構文の色が付きます。
```swift
let greeting = "Hello"
```
diffと付けたブロックでは、+と-で始まる行に色が付きます。mermaidと付けたブロックは図になります。
リンクと画像
[DotMD](https://getdotmd.com)

[the plan](plan.md)
[setup](#setup)
リンクは、テキストを角括弧、アドレスを丸括弧に入れます。Webのアドレスだけを書いても、リンクになります。画像は、前に!を付けたリンクで、そのテキストはスクリーンリーダー向けの説明になります。パスは文書からの相対パスで、リンク先には別の.mdファイルや見出しも指定できます。見出しのアンカーは、その文字を小文字にして、スペースを-に変えたものです。
長いアドレスや繰り返すアドレスは、下にまとめて置き、短い名前で参照できます。[guide][1]と書いて、別の行に[1]: https://example.com/guideと書きます。
コールアウト、コメント、フロントマター
> [!NOTE]
> Useful information that users should know.
最初の行が[!NOTE]、[!TIP]、[!IMPORTANT]、[!WARNING]、[!CAUTION]のいずれかである引用は、色付きの囲みになります。GitHubと同じ記法です。
- ページに表示されないコメント:
<!-- a note only visible in the text -->。 - HTMLの
<details>と<summary>による折りたたみ。中のMarkdownの前後に空行を入れます。 - フロントマター:ファイルの先頭の行にある、
---で挟まれたブロックで、タイトル、タグ、ステータスなどを書きます。DotMDは文書の上にPropertiesカードとして表示します。
数式と図
GitHubとDotMDの両方が描く、2つの拡張です。数式はドル記号で囲む$E = mc^2$か、単独の行で二重のドル記号で囲みます。LaTeXによるMarkdownの数式。図は、mermaidと付けたコードブロックの中に書きます。Mermaid図。
試してみる
記号を覚える一番の近道は、整形された表示を見ることです。DotMDで.mdファイルを開くと、表、コード、コールアウト、図、数式が描かれた状態で読めます。閲覧は無料です。エディタではInsertメニューが記号を入力してくれるので、このページの内容を覚えておく必要はありません。
Markdownの記法についての質問
MarkdownとGitHub Flavored Markdownの違いは何ですか?
GitHub Flavored Markdownは、基本の記法に、表、タスクリスト、取り消し線、自動リンクを加えたものです。
改行はどうやって入れますか?
行末にスペース2つかバックスラッシュを付けるか、空行を空けて新しい段落にします。
表示されないコメントはどう書きますか?
<!-- like this -->と書きます。ページでは隠れ、テキストの上でだけ見えます。
Markdownを整形した状態で見るには?
DotMDで.mdファイルを開きます。閲覧は無料です。編集については料金を参照してください。