Markdown拡張構文
基本的なMarkdown構文はドキュメント作成の基本要素を提供しますが、特定のニーズには十分でない場合があります。そこで拡張構文が登場します。
拡張構文は基本的な構文の上に追加の機能を提供し、より豊かで複雑なドキュメントを作成できるようにします。
拡張構文とは?
拡張構文は、元のMarkdown仕様を超える構文要素を指します。これらの拡張は、追加機能をサポートするために異なるMarkdownプロセッサによって追加されます。
一般的な拡張構文
- テーブル – データテーブルの作成
- フェンスコードブロック – 構文ハイライト付きコードブロック
- 脚注 – 脚注参照の追加
- 見出しID – 見出しへのカスタムIDの追加
- 定義リスト – 用語と定義のリスト
- 取り消し線 – テキストの取り消し
- タスクリスト – チェックボックス付きチェックリスト
- 絵文字 – 絵文字シンボル
- ハイライト – テキストのハイライト
- 下付き文字と上付き文字 – 数式でよく使用
サポート
すべてのMarkdownアプリケーションが拡張構文をサポートしているわけではないことに注意してください。使用する前に、使用したい拡張機能がMarkdownプロセッサでサポートされているか確認してください。
メインストリームのサポート
以下のプラットフォームとツールは拡張構文を十分にサポートしています:
- GitHub Flavored Markdown (GFM) – GitHubのMarkdown拡張
- GitLab Flavored Markdown – GitLabの拡張
- Typora – リッチテキストMarkdownエディター
- Obsidian – ナレッジ管理ツール
- VitePress – 静的サイトジェネレーター
- Hugo – 静的サイトジェネレーター
テーブル
テーブルの作成は最も一般的な拡張の1つです:
markdown
| 名前 | 年齢 | 職業 |
|-------|-----|----------|
| 張 | 25 | エンジニア |
| 李 | 30 | デザイナー |
名前 | 年齢 | 職業 |
---|---|---|
張 | 25 | エンジニア |
李 | 30 | デザイナー |
フェンスコードブロック
構文ハイライト付きのコードブロック:
markdown
```javascript
function hello() {
console.log("Hello, World!");
}
```
javascript
function hello() {
console.log("Hello, World!");
}
タスクリスト
ToDoリストの作成:
markdown
- [x] プロジェクト計画の完了
- [ ] コードの作成
- [ ] 機能のテスト
- [ ] オンラインデプロイ
- [x] プロジェクト計画の完了
- [ ] コードの作成
- [ ] 機能のテスト
- [ ] オンラインデプロイ
取り消し線
削除または不正な内容を示します:
markdown
~~このテキストは取り消し線付き~~
このテキストは取り消し線付き
自動リンク
URLとメールアドレスを自動的に認識:
markdown
詳細は https://markdown.com.cn をご覧ください。
連絡先: example@domain.com
詳細は https://markdown.com.cn をご覧ください。 連絡先: example@domain.com
脚注
ドキュメントに注釈と参照を追加:
markdown
これは脚注の例です[^1]。
[^1]: これが脚注の内容です。
これは脚注の例です^1。
定義リスト
用語と定義のリストを作成:
markdown
Markdown
: 軽量マークアップ言語
HTML
: ハイパーテキストマークアップ言語
: Webページ作成のための標準マークアップ言語
数式
LaTeXスタイルの数式をサポート:
markdown
インライン数式: $E = mc^2$
ブロック数式:
$$
\sum_{i=1}^n a_i = 0
$$
チャートと図
一部の高度なエディターはMermaidダイアグラムをサポートします:
markdown
```mermaid
graph TD
A[開始] --> B{理解?}
B -->|はい| C[学習続行]
B -->|いいえ| D[再度読む]
D --> B
C --> E[終了]
```
拡張構文の学習パス
拡張構文は以下の順序で学習することをお勧めします:
- テーブル – 最も一般的で実用的
- フェンスコードブロック – プログラマーに不可欠
- タスクリスト – プロジェクト管理に最適
- 取り消し線 – シンプルで使いやすい
- 脚注 – 学術執筆に必要
- 定義リスト – 用語説明用
- 見出しID – 高度なリンク
- ハイライト – 重要なポイントを強調
互換性に関する注意
拡張構文を使用する際:
- 互換性のテスト – ターゲットプラットフォームでMarkdownをテスト
- フォールバックの提供 – 拡張機能をサポートしないプラットフォームでの表示を考慮
- 使用法の文書化 – ドキュメントで使用する拡張機能を明記
- 選択の標準化 – チーム内で統一された拡張機能セットを使用
次のステップ
興味のある拡張構文を選んで学習を始めましょう: