Markdownの基本構文
Markdownは、フォーマットよりもコンテンツに集中できる、シンプルな構文を持つ軽量マークアップ言語です。読みやすく書きやすいプレーンテキスト形式を使用し、HTMLと混在させることができ、HTML、PDF、または独自の.mdファイル形式にエクスポートできます。
設計哲学
Markdownの目標は「読みやすさと書きやすさ」です。
読みやすさが最も重要です。Markdownで書かれたファイルは、プレーンテキストとして公開でき、タグや書式設定の指示で埋め尽くされているように見えないようにします。
Markdownの構文の主な設計目標は、可能な限り読みやすくすることです。この目標に基づき、Markdownドキュメントはプレーンテキストとして公開でき、タグや書式設定の指示で埋め尽くされているように見えません。
—— John Gruber
HTMLとの互換性
Markdownの構文の目標は、Webに適した記述言語になることです。
Markdownは、HTMLを置き換えることや、HTMLに近づくことを目指していません。その構文は限定的で、HTMLタグのごく一部のみをカバーしています。
Markdownでカバーされていないタグは、直接ドキュメントにHTMLで記述できます。それがHTMLかMarkdownかをマークする必要はなく、タグを直接追加するだけです。
例えば、MarkdownファイルにHTMLテーブルを追加します:
これは通常の段落です。
<table>
<tr>
<td>Foo</td>
</tr>
</table>
これは別の通常の段落です。
特殊文字の自動変換
HTMLファイルでは、<
と&
の2つの文字は特別な処理が必要です。
<
はタグの開始に使用されます&
はHTMLエンティティに使用されます
Markdownでは、これらの文字を自然に記述でき、変換を自動的に処理します。使用する&
がHTMLエンティティの一部である場合、そのまま保持されます。それ以外の場合は、&
に変換されます。
基本的な構文要素
Markdownの基本的な構文には、以下の要素が含まれます:
ブロック要素
- 見出し -
#
を使用して様々なレベルの見出しを作成 - 段落と改行 - テキスト段落と改行のルール
- ブロッククォート -
>
を使用してブロッククォートを作成 - リスト - 順序付きおよび順序なしリスト
- コードブロック - コードを表示するための特別な形式
- 水平線 - 水平線を作成
インライン要素
その他
構文の例
以下は、様々な基本的な構文要素を含む例です:
# マイドキュメント
これは**太字テキスト**と*斜体テキスト*の例です。
## リストの例
### ショッピングリスト
- リンゴ
- バナナ
- オレンジ
### タスクリスト
1. Markdownの基本を学ぶ
2. 書くことを練習
3. 友人と共有
> これはブロッククォートの例です。Markdownは書くことをシンプルでエレガントにします。
これは[ホームページへのリンク](/ja/)の例です。
コード例:
インラインコードも使用できます。例えば、console.log('Hello World')
のようになります。
ベストプラクティス
見出し
- 文書ごとに1つのレベル1見出し(
#
)のみを使用 - 見出しレベルを論理的に保ち、レベルをスキップしない
- 見出しの前後に空白行を残す
リストのフォーマット
- 順序なしリストの記号を一貫して保つ(
-
、*
、+
のいずれかのみを使用) - 複数の段落がない限り、リスト項目間に空白行は不要
リンクと画像
- リンクには意味のあるテキスト説明を提供
- 画像にはalt(代替)テキストを提供
コードの表示
- 短いコードにはインラインコードを使用
- 長いまたは複数行のコードにはコードブロックを使用
- コードブロックの言語を指定して構文強調を有効にする
ツールのサポート
ほぼすべてのMarkdownアプリケーションがこれらの基本的な構文要素をサポートしています。異なるMarkdownプロセッサ間で若干の違いがある場合がありますが、基本的な構文は普遍的です。
次のステップ
Markdownの基本構文の概要を理解したら、以下のことができます:
特定の構文要素の学習を開始: