Markdown: マークダウンのブロック引用構文とネスト
ブロック引用により文書の説得力が高まります。専門家の意見を引用する場合でも、重要なメモを強調する場合でも、ブロック引用はその仕事に最適なツールです。
1. 学ぶこと
- 基本的なブロッククオート構文と使用法
- 複数の段落とネストされたブロック引用符
- ブロック引用符内にリスト、コード、見出しを埋め込む
- 文書レイアウトにおけるブロッククオートのベストプラクティス
- ブロッククオートとコールアウトボックス
2. テクニカル ライティング トレーナーの実話
(1) 問題点: 引用符の誤用
ジョーダンは、技術チーム向けにドキュメント作成のワークショップを実施していましたが、ほぼ全員が間違った方法で「引用」を行っていることを発見しました。一部のテキストは手動で灰色のフォントでインデントされたり、一部のテキストは斜体になったり、他の人のテキストのスクリーンショットを貼り付けたりしていました。引用が本文に溶け込んでおり、どの部分が著者自身の言葉で、どの部分が外部情報源であるかを読者が区別することができなくなりました。
(2) 解決策: > で見積もりの書式を統一する
ジョーダンはチーム ルールを設定しました。引用された外部テキスト、重要なヒント、警告はすべて > ブロック引用構文を使用する必要があります。チームの lint スクリプトは、標準の引用形式をチェックします。 3 か月後、引用の一貫性は 30% から 98% に上昇しました。
3. ブロッククオートの基本
(1) 基本的な構文
ブロック引用を作成するには、行の先頭で > を使用します。
> This is a blockquote.
> This is the second line of the quote.
> を追加するのが最も安全な方法です。一部のパーサーは、段落の先頭で単一の > もサポートしています。
> This is a blockquote paragraph with > only on the first line.
This is the continuation (supported by some parsers).
> を追加してください。
(2) ブロック引用符内の空白行
ブロック引用符内の空白行にも > が必要です。
> First paragraph.
>
> Second paragraph (with a blank line and `>` in between).
▶ 例: 標準的なブロッククォートの使用法
In *The Pragmatic Programmer*, the authors point out:
> The core of software development is not writing code, but managing complexity.
> A good programmer is not the one who writes the most code, but the one who makes code clearest.
▶ 例: 会話型のネストされたブロック引用符
> **Project Manager:** Can this feature go live this Friday?
>
> > **Developer:** The core functionality is ready, but some edge cases still need testing.
> >
> > > **QA Engineer:** I've run 80% of the test cases. Should have results by Wednesday.
5. ブロック引用符内のその他の要素
(1) ブロック引用符内の見出し
> ## Core Argument of the Quoted Material
>
> This is the main body of the quoted content.
>
> ### Sub-Argument 1
>
> Detailed explanation of the sub-argument.
(2) ブロック引用符で囲まれたリスト
> Project Requirements:
>
> - Support 1,000 concurrent users
> - Response time < 200ms
> - 99.9% availability
(3) ブロック引用符内のコード ブロック
> **Core Algorithm:**
>
> ```python
> def fibonacci(n):
> if n <= 1:
> return n
> return fibonacci(n-1) + fibonacci(n-2)
> ```
>
> The above algorithm has O(2^n) time complexity and can be optimized with dynamic programming.
▶ 例: ブロック引用符に複数の要素を埋め込む
> ## Technical Design Review Results
>
> After team evaluation, we've decided to adopt a **microservice architecture**.
>
> | Approach | Scalability | Maintenance Cost |
> |:-----|:------:|:--------:|
> | Monolith | Low | Low |
> | Microservices | High | High |
>
> > Note: Microservices are suitable for teams of 10+. Small teams should start with a monolith.
6. ブロッククオートとコールアウトボックス
このチュートリアル全体で使用される > 構文と > **💡 Tip:** パターンはどちらもブロック引用符ですが、目的が異なります。
| タイプ | 構文 | 外観 | 目的 |
|---|---|---|---|
| 標準ブロック引用 | > text |
灰色の縦棒 | 外部ソースの引用、対話 |
| ヒントの吹き出し | > **💡 Tip:** text |
灰色のバー + アイコン | 重要なヒント、重要な注意事項 |
| 警告コールアウト | > **⚠️ Note:** text |
灰色のバー + アイコン | 警告、よくある落とし穴 |
> Standard blockquote: quoting an external author's viewpoint.
> **💡 Tip:** This is a tip callout—it emphasizes key information for the reader.
> **⚠️ Note:** This is a warning callout—it alerts readers to risks and helps them avoid pitfalls.
7. レイアウトでの高度なブロッククォートの使用法
(1) ブロック引用符を「サイドバー」として使用する
## Key Decision
We chose PostgreSQL as our primary database.
> **Decision Rationale:**
> 1. The team has 3 years of PostgreSQL experience
> 2. The project needs complex queries and transaction support
> 3. Tight budget—PostgreSQL is open-source and free
(2) 引用符内の引用符 (レイヤーごと)
The original paper states:
> Experimental results show this method is effective.
>
> > Subsequent research further confirms:
> >
> > > After 10 independent replications, the results are consistent.
8. 完全な例: ブロック引用符を使用した技術レビューの構成
# Architecture Review Report
## Review Conclusion
Following the architecture review meeting on June 15, 2026, the team has made the following decisions:
## Database Selection
> **Final Decision:** Adopt PostgreSQL.
>
> **Rationale:**
> - The project requires complex geospatial queries (PostGIS)
> - The team has extensive PostgreSQL experience
> - Compared to MongoDB, PostgreSQL offers more robust transaction support
>
> | Comparison | PostgreSQL | MongoDB |
> |:-------|:----------:|:-------:|
> | Transactions | ✅ ACID | ✅ Multi-doc |
> | Geospatial | ✅ PostGIS | ✅ Built-in |
> | Team Experience | 3 years | 1 year |
## Deployment Plan
> **CEO's Opinion:**
>
> > I suggest starting with a monolith and splitting it once user numbers grow.
>
> **Engineering Team's Response:**
>
> We agree with this strategy. However, the database connection layer will be an independent module to facilitate future microservice migration.
## Reminders
> **⚠️ Note:** During migration, keep the old system running simultaneously for at least 2 weeks to ensure data integrity.
期待される結果: ブロック引用符によってさまざまな参加者の意見と最終決定が明確に区別される、専門的なアーキテクチャ レビュー ドキュメント。
❓ よくある質問
>  は、ブロック引用符内の画像としてレンダリングされます。ただし、ブロック引用符内の大きな画像は窮屈に感じる可能性があるため、使用は控えめにしてください。<blockquote> 要素としてレンダリングされます。📖 まとめ
- ブロック引用符では
>を使用し、互換性を最大限に高めるためにすべての行に追加します。 - マルチレベルのネストでは
>>、>>>を使用します。3 レベルを超えないでください。 - ブロック引用符には、見出し、リスト、コード ブロック、表を含めることができます
- ブロッククォートは、外部ソースを引用し、重要な情報を強調するのに最適です
- 吹き出しは、視覚的に区別できるように絵文字と太字の書式を使用して拡張されたブロック引用符です
- 引用文は簡潔にしてください - 長い引用符は文書の流れを妨げます
📝 練習問題
-
基本: ブロック引用符を使用し、空行
>で区切られた少なくとも 2 つの段落を持つ短い書評を書きます。 -
中級: 「教師が専門家を引用し、次に生徒が教師の説明を引用する」シナリオをシミュレートする二重ネストのブロック引用を作成します。各レベルには少なくとも 2 ~ 3 行が必要です。
-
課題: 標準のブロック引用符 (外部ソースの引用)、警告コールアウト (⚠️ リスク アラート)、表 (アプローチの比較)、およびコード ブロック (サンプル コード) をすべてブロック引用符内で組み合わせた「技術的決定ログ」を作成し、レンダリングをテストします。