概要

ほぼすべての Markdown アプリケーションは、オリジナルの Markdown 設計ドキュメントで概説されている基本構文をサポートしています。 Markdown プロセッサの間にはわずかなバリエーションと不一致がありますが、可能な限りインラインで注記しています。

見出し

見出しを作成するには、単語またはフレーズの前に番号記号 (#) を追加します。使用する番号記号の数は、見出しレベルに対応する必要があります。たとえば、レベル 3 の見出し (<h3>) を作成するには、3 つの番号記号 (例: ### 見出し) を使用します。

代替構文

または、テキストの下の行に、見出しレベル 1 の場合は == 文字を任意数、見出しレベル 2 の場合は -- 文字を任意数追加します。

見出しのベストプラクティス

Markdown アプリケーションは、番号記号 (#) と見出し名の間のスペースがない場合の処理方法について同意していません。互換性のために、番号記号と見出し名の間に常にスペースを入れてください。

また、互換性のために、見出しの前後に空行を入れる必要があります。

段落

段落を作成するには、空白行を使用して 1 行以上のテキストを区切ります。

段落のベストプラクティス

段落がリスト内にある場合を除き、スペースまたはタブで段落をインデントしないでください。

改行

改行または新しい行 (<br>) を作成するには、行の末尾に 2 つ以上のスペースを入力し、Return キーを押します。

改行のベストプラクティス

ほぼすべての Markdown アプリケーションで、行の改行に 2 つ以上のスペース (一般に「末尾の空白」と呼ばれます) を使用できますが、これは議論の余地があります。エディターで末尾の空白を見るのは難しく、多くの人が誤って、または意図的にすべての文の後に 2 つのスペースを入れています。このため、改行に末尾の空白以外のものを使用したい場合があります。Markdown アプリケーションが HTML をサポートしている場合は、<br> HTML タグを使用できます。

互換性のために、行末に末尾の空白または <br> HTML タグを使用してください。

使用を推奨しない 2 つのオプションが他にあります。 CommonMark およびその他のいくつかの軽量マークアップ言語では、行の末尾にバックスラッシュ (\) を入力できますが、すべての Markdown アプリケーションがこれをサポートしているわけではないため、互換性の観点からは優れたオプションではありません。また、少なくともいくつかの軽量マークアップ言語では、行末に何も必要ありません。Return キーを押すだけで改行が作成されます。

強調

テキストを太字またはイタリック体にして強調を追加できます。

太字

テキストを太字にするには、単語またはフレーズの前後に 2 つのアスタリスクまたはアンダースコアを追加します。強調のために単語の真ん中を太字にするには、文字の周りにスペースを入れずに 2 つのアスタリスクを追加します。

太字のベストプラクティス

Markdown アプリケーションは、単語の途中でアンダースコアを処理する方法について同意していません。互換性のために、単語の真ん中を強調して太字にするには、アスタリスクを使用します。

イタリック体

テキストをイタリック体にするには、単語またはフレーズの前後に 1 つのアスタリスクまたはアンダースコアを追加します。強調のために単語の真ん中をイタリック体にするには、文字の周りにスペースを入れずに 1 つのアスタリスクを追加します。

イタリック体のベストプラクティス

Markdown アプリケーションは、単語の途中でアンダースコアを処理する方法について同意していません。互換性のために、単語の真ん中を強調してイタリック体にするには、アスタリスクを使用します。

太字とイタリック体

テキストを太字とイタリック体で同時に強調するには、単語またはフレーズの前後に 3 つのアスタリスクまたはアンダースコアを追加します。強調のために単語の真ん中を太字とイタリック体にするには、文字の周りにスペースを入れずに 3 つのアスタリスクを追加します。

太字とイタリック体のベストプラクティス

Markdown アプリケーションは、単語の途中でアンダースコアを処理する方法について同意していません。互換性のために、単語の真ん中を強調して太字とイタリック体にするには、アスタリスクを使用します。

引用符

引用符を作成するには、段落の前に > を追加します。

> Dorothy followed her through many of the beautiful rooms in her castle.

レンダリングされた出力は次のようになります

ドロシーは彼女について、彼女の城の多くの美しい部屋を歩きました。

複数段落の引用符

引用符には、複数の段落を含めることができます。段落間の空白行に > を追加します。

> Dorothy followed her through many of the beautiful rooms in her castle.
>
> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

レンダリングされた出力は次のようになります

ドロシーは彼女について、彼女の城の多くの美しい部屋を歩きました。

魔女は彼女に鍋やケトルを掃除し、床を掃き、火を薪で燃やし続けるように命じました。

ネストされた引用符

引用符はネストできます。ネストしたい段落の前に >> を追加します。

> Dorothy followed her through many of the beautiful rooms in her castle.
>
>> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

レンダリングされた出力は次のようになります

ドロシーは彼女について、彼女の城の多くの美しい部屋を歩きました。

魔女は彼女に鍋やケトルを掃除し、床を掃き、火を薪で燃やし続けるように命じました。

他の要素を含む引用符

引用符には、他の Markdown でフォーマットされた要素を含めることができます。すべての要素を使用できるわけではありません。どれが機能するかを試してみる必要があります。

> #### The quarterly results look great!
>
> - Revenue was off the chart.
> - Profits were higher than ever.
>
>  *Everything* is going according to **plan**.

レンダリングされた出力は次のようになります

四半期の業績は素晴らしいです！

• 収益はグラフから外れていました。
• 利益は過去最高でした。

すべてが計画通りに進んでいます。

引用符のベストプラクティス

互換性のために、引用符の前後に空白行を入れます。

リスト

項目を順序付きリストと順序なしリストに整理できます。

順序付きリスト

順序付きリストを作成するには、数字とピリオドが続く行項目を追加します。数字は数値順である必要はありませんが、リストは数字の 1 で始まる必要があります。

順序付きリストのベストプラクティス

CommonMark およびその他のいくつかの軽量マークアップ言語では、区切り文字として括弧 ()) (例: 1) 最初の項目) を使用できますが、すべての Markdown アプリケーションがこれをサポートしているわけではないため、互換性の観点からは優れたオプションではありません。互換性のために、ピリオドのみを使用してください。

順序なしリスト

順序なしリストを作成するには、行項目の前にダッシュ (-)、アスタリスク (*)、またはプラス記号 (+) を追加します。1 つ以上の項目をインデントして、ネストされたリストを作成します。

数字で始まる順序なしリスト項目

ピリオドが続く数字で始まる順序なしリスト項目が必要な場合は、バックスラッシュ (\) を使用してピリオドをエスケープできます。

順序なしリストのベストプラクティス

Markdownアプリケーションは、同じリスト内で異なる区切り文字をどのように処理するかについて、意見が一致しません。互換性のために、同じリスト内で区切り文字を混在させないでください。1つを選んで、それに固執してください。

リストに要素を追加する

リストの連続性を維持しながらリストに別の要素を追加するには、次の例に示すように、要素を4つのスペースまたは1つのタブでインデントします。

段落

* This is the first list item.
* Here's the second list item.

    I need to add another paragraph below the second list item.

* And here's the third list item.

レンダリングされた出力は次のようになります

• これは最初のリスト項目です。

• これは2番目のリスト項目です。

  2番目のリスト項目の下に別の段落を追加する必要があります。

• そして、これが3番目のリスト項目です。

引用符

* This is the first list item.
* Here's the second list item.

    > A blockquote would look great below the second list item.

* And here's the third list item.

レンダリングされた出力は次のようになります

• これは最初のリスト項目です。

• これは2番目のリスト項目です。

  引用文は2番目のリスト項目の下にあると見栄えがよくなります。

• そして、これが3番目のリスト項目です。

コードブロック

コードブロックは通常、4つのスペースまたは1つのタブでインデントされます。リスト内にある場合は、8つのスペースまたは2つのタブでインデントします。

1. Open the file.
2. Find the following code block on line 21:

        <html>
          <head>
            <title>Test</title>
          </head>

3. Update the title to match the name of your website.

レンダリングされた出力は次のようになります

1. ファイルを開きます。

2. 21行目の次のコードブロックを見つけてください。

    <html>
      <head>
        <title>Test</title>
      </head>
   

3. ウェブサイトの名前に合わせてタイトルを更新してください。

画像

1. Open the file containing the Linux mascot.
2. Marvel at its beauty.

    ![Tux, the Linux mascot](/assets/images/tux.png)

3. Close the file.

レンダリングされた出力は次のようになります

1. Linuxマスコットを含むファイルを開きます。

2. その美しさに驚嘆してください。

   

3. ファイルを閉じます。

リスト

順序付きリストに順序なしリストをネストしたり、その逆も可能です。

1. First item
2. Second item
3. Third item
    - Indented item
    - Indented item
4. Fourth item

レンダリングされた出力は次のようになります

1. 最初の項目
2. 2 番目の項目
3. 3 番目の項目
   • インデントされた項目
   • インデントされた項目
4. 4 番目の項目

コード

単語またはフレーズをコードとして示すには、バッククォート(`)で囲みます。

バッククォートのエスケープ

コードとして示す単語またはフレーズに1つ以上のバッククォートが含まれている場合は、単語またはフレーズをダブルバッククォート(``)で囲むことでエスケープできます。

コードブロック

コードブロックを作成するには、ブロックのすべての行を少なくとも4つのスペースまたは1つのタブでインデントします。

    <html>
      <head>
      </head>
    </html>

レンダリングされた出力は次のようになります

<html>
  <head>
  </head>
</html>

水平線

水平線を作成するには、3つ以上のアスタリスク(***)、ダッシュ(---)、またはアンダースコア(___)を1行に単独で使用します。

***

---

_________________

3つすべてがレンダリングされた出力は同じに見えます。

水平線のベストプラクティス

互換性のために、水平線の前後に空白行を入れます。

リンク

リンクを作成するには、リンクテキストを角括弧（例：[Duck Duck Go]）で囲み、その直後にURLを括弧で囲みます（例：(https://duckduckgo.com)）。

My favorite search engine is [Duck Duck Go](https://duckduckgo.com).

レンダリングされた出力は次のようになります

私のお気に入りの検索エンジンはDuck Duck Goです。

タイトルの追加

オプションで、リンクにタイトルを追加できます。これは、ユーザーがリンクの上にカーソルを置くとツールチップとして表示されます。タイトルを追加するには、URLの後に引用符で囲みます。

My favorite search engine is [Duck Duck Go](https://duckduckgo.com "The best search engine for privacy").

レンダリングされた出力は次のようになります

私のお気に入りの検索エンジンはDuck Duck Goです。

URLとメールアドレス

URLまたはメールアドレスをすばやくリンクに変えるには、山かっこで囲みます。

<https://markdownguide.dokyumento.jp>
<fake@example.com>

レンダリングされた出力は次のようになります

https://markdownguide.dokyumento.jp
fake@example.com

リンクの書式設定

リンクを強調するには、角括弧と括弧の前後にアスタリスクを追加します。リンクをコードとして示すには、角括弧にバッククォートを追加します。

I love supporting the **[EFF](https://eff.org)**.
This is the *[Markdown Guide](https://markdownguide.dokyumento.jp)*.
See the section on [`code`](#code).

レンダリングされた出力は次のようになります

私はEFFをサポートするのが大好きです。
これはMarkdown Guideです。
コードに関するセクションを参照してください。

参照スタイルのリンク

参照スタイルのリンクは、MarkdownでURLを表示および読みやすくする特殊な種類のリンクです。参照スタイルのリンクは、テキスト内に保持する部分と、テキストを読みやすくするためにファイルの別の場所に保存する部分の2つの部分で構成されています。

リンクの最初の部分の書式設定

参照スタイルのリンクの最初の部分は、2つの角括弧のセットで書式設定されます。最初の角括弧のセットは、リンクされるべきテキストを囲みます。2番目の角括弧のセットは、ドキュメントの別の場所に保存しているリンクを指すために使用されるラベルを表示します。

必須ではありませんが、最初の角括弧と2番目の角括弧の間にスペースを含めることができます。2番目の角括弧内のラベルは大文字と小文字が区別されず、文字、数字、スペース、または句読点を含めることができます。

これは、次の例の形式がリンクの最初の部分とほぼ同じであることを意味します。

• [hobbit-hole][1]
• [hobbit-hole] [1]

リンクの2番目の部分の書式設定

参照スタイルのリンクの2番目の部分は、次の属性で書式設定されます。

1. ラベル（角括弧内）の直後にコロンと少なくとも1つのスペースが続きます（例：[label]: ）。
2. リンクのURL。これは、オプションで山かっこで囲むことができます。
3. リンクのオプションのタイトル。これは、二重引用符、一重引用符、または括弧で囲むことができます。

これは、次の例の形式がすべて、リンクの2番目の部分とほぼ同じであることを意味します。

• [1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle
• [1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle "ホビットのライフスタイル"
• [1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle 'ホビットのライフスタイル'
• [1]: https://en.wikipedia.org/wiki/Hobbit#Lifestyle (ホビットのライフスタイル)
• [1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> "ホビットのライフスタイル"
• [1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> 'ホビットのライフスタイル'
• [1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> (ホビットのライフスタイル)

このリンクの2番目の部分は、Markdownドキュメントの任意の場所に配置できます。段落の直後に配置する人もいれば、ドキュメントの最後（巻末注または脚注のように）に配置する人もいます。

部品をまとめた例

段落に標準URLリンクとしてURLを追加すると、Markdownでは次のようになります。

In a hole in the ground there lived a hobbit. Not a nasty, dirty, wet hole, filled with the ends
of worms and an oozy smell, nor yet a dry, bare, sandy hole with nothing in it to sit down on or to
eat: it was a [hobbit-hole](https://en.wikipedia.org/wiki/Hobbit#Lifestyle "Hobbit lifestyles"), and that means comfort.

追加の興味深い情報を指している可能性がありますが、表示されるURLは、読みづらくなる以外に、既存の生のテキストにはあまり追加されません。それを修正するために、代わりにURLを次のように書式設定できます。

In a hole in the ground there lived a hobbit. Not a nasty, dirty, wet hole, filled with the ends
of worms and an oozy smell, nor yet a dry, bare, sandy hole with nothing in it to sit down on or to
eat: it was a [hobbit-hole][1], and that means comfort.

[1]: <https://en.wikipedia.org/wiki/Hobbit#Lifestyle> "Hobbit lifestyles"

上記のどちらの場合でも、レンダリングされた出力は同じになります。

地面の穴の中に、ホビットが住んでいました。みみずの端やねばねばした臭いが満ちた、不快で汚い、湿った穴でも、座ったり食べたりするものが何も入っていない、乾燥した、むき出しの砂の穴でもありませんでした。それはホビットの穴で、それは快適さを意味します。

そして、リンクのHTMLは次のようになります。

<a href="https://en.wikipedia.org/wiki/Hobbit#Lifestyle" title="Hobbit lifestyles">hobbit-hole</a>

リンクのベストプラクティス

Markdownアプリケーションは、URLの途中のスペースをどのように処理するかについて意見が一致しません。互換性のために、%20を使用してスペースをURLエンコードしてみてください。または、MarkdownアプリケーションがHTMLをサポートしている場合は、a HTMLタグを使用できます。

URLの途中の括弧も問題になる可能性があります。互換性のために、開き括弧(()を%28で、閉じ括弧())を%29でURLエンコードしてみてください。または、MarkdownアプリケーションがHTMLをサポートしている場合は、a HTMLタグを使用できます。

画像

画像を追加するには、感嘆符(!)を追加し、その後に角括弧内の代替テキストと、括弧内の画像アセットへのパスまたはURLを追加します。オプションで、パスまたはURLの後に引用符で囲んでタイトルを追加できます。

![The San Juan Mountains are beautiful!](/assets/images/san-juan-mountains.jpg "San Juan Mountains")

レンダリングされた出力は次のようになります

画像のリンク

画像にリンクを追加するには、画像のMarkdownを角括弧で囲み、その後に括弧で囲んでリンクを追加します。

[![An old rock in the desert](/assets/images/shiprock.jpg "Shiprock, New Mexico by Beau Rogers")](https://www.flickr.com/photos/beaurogers/31833779864/in/photolist-Qv3rFw-34mt9F-a9Cmfy-5Ha3Zi-9msKdv-o3hgjr-hWpUte-4WMsJ1-KUQ8N-deshUb-vssBD-6CQci6-8AFCiD-zsJWT-nNfsgB-dPDwZJ-bn9JGn-5HtSXY-6CUhAL-a4UTXB-ugPum-KUPSo-fBLNm-6CUmpy-4WMsc9-8a7D3T-83KJev-6CQ2bK-nNusHJ-a78rQH-nw3NvT-7aq2qf-8wwBso-3nNceh-ugSKP-4mh4kh-bbeeqH-a7biME-q3PtTf-brFpgb-cg38zw-bXMZc-nJPELD-f58Lmo-bXMYG-bz8AAi-bxNtNT-bXMYi-bXMY6-bXMYv)

レンダリングされた出力は次のようになります

文字のエスケープ

Markdownドキュメントでテキストの書式設定に使用される文字をそのまま表示するには、文字の前にバックスラッシュ(\)を追加します。

\* Without the backslash, this would be a bullet in an unordered list.

レンダリングされた出力は次のようになります

* バックスラッシュがないと、これは順序なしリストの箇条書きになります。

エスケープできる文字

バックスラッシュを使用して、次の文字をエスケープできます。

HTML

多くのMarkdownアプリケーションでは、Markdown形式のテキストでHTMLタグを使用できます。これは、特定のHTMLタグをMarkdown構文よりも優先する場合に役立ちます。たとえば、HTMLタグを画像に使用する方が簡単だと感じる人もいます。HTMLの使用は、テキストの色を指定したり、画像の幅を変更したりするなど、要素の属性を変更する必要がある場合にも役立ちます。

HTMLを使用するには、Markdown形式のファイルのテキストにタグを配置します。

This **word** is bold. This <em>word</em> is italic.

レンダリングされた出力は次のようになります

この単語は太字です。この単語はイタリック体です。

HTMLのベストプラクティス

セキュリティ上の理由から、すべてのMarkdownアプリケーションがMarkdownドキュメントでHTMLをサポートしているわけではありません。不明な場合は、Markdownアプリケーションのドキュメントを確認してください。一部のアプリケーションは、HTMLタグのサブセットのみをサポートしています。

<div>、<table>、<pre>、および<p>などのブロックレベルのHTML要素を周囲のコンテンツから区切るには、空白行を使用します。タブやスペースでタグをインデントしないようにしてください。これは書式設定を妨げる可能性があります。

ブロックレベルのHTMLタグ内でMarkdown構文を使用することはできません。たとえば、<p>イタリック体と**太字**</p>は機能しません。

Markdownスキルを次のレベルに進めてください。

60ページでMarkdownを学びましょう。初心者と専門家の両方を対象に設計されたThe Markdown Guideは、Markdown構文を開始してマスターするために必要なすべてが揃った包括的なリファレンスです。

書籍を入手