見出しと段落
見出しには1〜6個のハッシュ記号を前置します。ドキュメントタイトルにはH1を1つ使い、見た目の大きさだけで見出しレベルを選ばず、階層に沿って下っていきます。段落は空行で区切ります。
見出しMarkdown
# Document title An opening paragraph. ## Installation Setup details. ### Environment variables Configuration details.
強調、リンク、画像
強調にはアスタリスク、リンクの表示テキストには角括弧、リンク先には丸括弧を使います。画像構文では感嘆符を追加します。画像が見えない場合も意味のある代替テキストが重要です。
インライン構文Markdown
Use **bold** for strong importance and *italic* for emphasis. Read the [deployment guide](/guides/deploy). 
リストとタスクリスト
順序なしリストの項目はハイフン、順序付きリストの項目は数字で始めます。ネストした項目は一貫したインデントを使います。多くの開発者向けプラットフォームでは、GitHub Flavored Markdownによるタスクリストのチェックボックスもサポートされています。
リストMarkdown
- Prepare the release - Update the changelog - Freeze migrations - Deploy 1. Start the canary 2. Watch metrics 3. Expand traffic - [x] Tests pass - [ ] Docs reviewed
インラインコードとフェンス付きコードブロック
短い識別子やコマンドはバッククォート1つで囲みます。長い例はトリプルバッククォートのフェンスで囲み、レンダラーがシンタックスハイライトに対応していれば言語名を付けます。実行可能な例は、理解してテストできる程度に完全な状態を保ちます。
コードMarkdown
Set `SERVICE_URL` in the server environment.
```ts
type Result = {
markdown: string;
fileName: string;
};
```引用、区切り線、テーブル
引用は、引用文や短い注記に便利です。水平線は大きな区切りを表します。テーブルはコンパクトで長方形のデータに適しています。セルに長い文章が入ったり、テーブルが非常に広くなると読みづらくなります。
GFMテーブルMarkdown
> Conversion preserves structure, not pixel-perfect layout. --- | Format | Good for | Review | | --- | --- | --- | | DOCX | Styled prose | Tables | | CSV | Small datasets | Escaping |
どのレンダラーでも通用する構文を書く
見出し、リスト、テーブル、フェンス付きコードブロックの周囲には空行を残します。裸のURLより、説明のあるリンクを優先します。公開システムが明示的にサポートしサニタイズする場合を除き、生HTMLは避けます。プラットフォーム固有の機能を使う場合は、他の環境でも意味が通じるよう十分なプレーンテキストを含めます。
プレビューはこの環境での表示を確認するためのものです。最終的な互換性テストは、対象のリポジトリまたはドキュメントシステムで行ってください。