レッスン 2
Markdown 構文の基本
日常的な開発者執筆で見出し、リスト、リンク、強調、コードスパン、引用を使います。
開発者が最もよく使う Markdown パターンです。
見出し
# H1
## H2
### H3
可能ならドキュメントタイトルに # を 1 つ使い、## と ### でセクションをネストします。
強調
*italic* or _italic_
**bold** or __bold__
`inline code`
リスト
順序なし:
- install dependencies
- run tests
- open a pull request
順序付き:
1. clone the repo
2. create a branch
3. commit changes
リンク
Read the [API docs](https://example.com/docs).
コードブロック
インラインコードはバッククォートを使います。複数行コードは通常フェンスブロックを使います。
```bash
npm test
```
引用
> Note: this endpoint requires authentication.
要点
良い Markdown はシンプルに保ちます。明確な見出し階層、短いリスト、明示的なリンク、コマンドや JSON サンプル向けのフェンスコードブロックです。
例を Markdown Preview / Markdown to HTML ツールに貼り付け、見出し、リスト、コードが期待どおりレンダリングされるか確認してください。