Markdownフォーマットを使用してウェブページを書く

(このテキストは、the original Markdown syntax page)のコピーです。



概要

理念

Markdownは、可能な限り簡単に読み、簡単に書くことを目的としています。

しかしながら、何にもまして読みやすいことが重要視されています。 Markdownフォーマットドキュメントは、タグによるマークアップやフォーマットインストラクション無しに、プレインテキストとしてそのまま公開されます。 Markdownのシンタックスは、 SetextatxTextilereStructuredTextGrutatextEtText を含む幾つかのテキストtoHTMLフィルタに影響を受けました。 しかし、Markdownのシンタックスの一番大きなインスピレーションの源は、プレインテキストメールのフォーマットです。

このため、Markdownのシンタックスは、完全に句読記号文字から成ります。句読記号文字は、それらが意味するとおりに見えるように慎重に選ばれました。 例えば、言葉の周りのアスタリスクは実際には*強調*のように見えます。Markdownではリストとして表示されます。 あなたがメールを使用したことがあると仮定して、blockquotes(引用)は引用されたテキストのように見えます。

インラインHTML

Markdownのシンタックスは、1つの事柄を目的としています: ウェブを記述するようなフォーマットとして使用する。

Markdownは、HTMLの代替物ではなく、むしろHTMLに近いと言えます。 シンタックスは非常にコンパクトで、HTMLタグの非常に小さなサブセットのみと一致します。 Markdownのアイディアは、HTMLタグを簡単に挿入できるシンタックスを作成することではありません。 私の見解として、HTMLタグは既に簡単に挿入することができるからです。 Markdownのアイディアは、簡単に読め、簡単に書け、散文的に編集できることにあります。 HTMLは出版するためのフォーマットです。これに対して、Markdownは書くためのフォーマットです。 従って、Markdownフォーマットシンタックスは、プレインテキストで表現することのみに重点を置いています。

Markdownシンタックスで表現できないマークアップには、単純にHTMLそのものを使用できます。 MarkdownからHTMLに切り替える場合、事前に記したり、区切り文字を入れる必要はありません。タグを使用するだけです。

唯一の制限事項は、ブロック要素を使用する場合です - 例 <div><table><pre><p>等 - これらは空白行で囲まれたコンテンツで分離する必要があります。また、開始および終了タグはタブまた空白でインデントしてはいけません。 Markdownは、余分(不必要)な<p>タグをブロック要素の周囲に追加することはありません。

例えば、HTMLテーブルをMarkdown記事に追加する場合:

これは通常の段落です。

<table>

    <tr>

        <td>Foo</td>

    </tr>

</table>

これはもう1つの通常の段落です。

注意: Markdownフォーマットシンタックスはブロック要素の中では処理されません 例、あなたはMarkdownスタイル *強調* をHTMLブロックの中で使用できません。

汎用的なインライン要素 - 例 <span><cite><del> - は、 Markdown段落、リスト、ヘッダのどこでも使用することができます。あなたが希望する場合、Markdownフォーマットの 代わりにHTMLタグを使用することもできます。例えば、HTMLの<a>または<img>タグをMarkdown のリンクやイメージのシンタックスの代わりに使用できます。

HTMLのブロック要素と異なり、Markdownシンタックスは汎用的なインライン要素の中でも処理されます

スペシャルキャラクタの自動エスケープ

HTMLには特別に扱う必要のある2つの文字があります: <&です。左鍵括弧タグの開始に使用し、アンパサンドはHTMLエンティティーを示すために使用します。 これらの文字を使用する場合は、エンティティーとしてエスケープする必要があります。例、&lt;&amp;です。

特にアンパサンドは、ホームページ製作者泣かせの存在です。‘AT&T’と書きたい場合、‘AT&amp;T’と書く必要があります。 さらに、URLの中でもアンパサンドをエスケープする必要があります。従って、次のようにリンクしたい場合:

http://images.google.com/images?num=30&q=larry+bird

アンカータグhrefの属性において、URLを次のようにエンコードする必要があります:

http://images.google.com/images?num=30&amp;q=larry+bird

言うまでもなく、このことは忘れやすく、恐らく適切にマークアップされたウェブサイトでHTML妥当性エラーが発生する最も一般的な原因となっています。

Markdownは必要に応じてエスケープ処理を行いますので、あなたはこれらの文字を自然に使うことができます。 アンパサンドをHTMLエンティティーの一部として使用したい場合は、そのままの状態にされます。そうで無い場合は、&amp;にエンコードされます。

ですから、あなたが著作権記号を記事に入れたい場合は、次のように記述できます:

&copy;

Markdownはアンパサンドをそのままにします。しかし、次のように記述すると:

AT&T

Markdownは次のようにエンコードします:

AT&amp;T

同様に、Markdownはinline HTMLをサポートします。鍵括弧をHTMLの区切り文字として使用する場合、Markdownは鍵括弧をそのままにします。しかし、次のように記述すると:

4 < 5

Markdownは次のようにエンコードします:

4 &lt; 5

しかし、Markdownコードspansとblocksの中では、鍵括弧、アンパサンドは常に自動的にエンコードされます。このことにより、Markdownを使用すると簡単にHTMLコードを記述することができます。 (逆に、生のHTMLでHTMLシンタックスを記述すると酷いことになります。あなたのサンプルコード内の全ての <& をエスケープする必要があるからです。)


ブロック要素

段落と改行

段落は、単純に1つまたはそれ以上の空白行で区切られた、1つまたはそれ以上の連続したテキストの行です。 (空白行は空白行に見えるあらゆる行を指します - スペースまたはタブを含んでいるに過ぎない行も空白行と見なされます。) 標準的な段落はスペースやタブで区切られることはありません。

「1つまたはそれ以上の連続したテキストの行」ルールは、Markdownが「ハードラップ」テキストの段落をサポートすることを意味します。 これは他の殆どのtext-toHTMLフォーマッタ(Movable Typeの「改行の変換」オプションも含む)が段落内の全ての改行を <br />タグに変換する のと極めて異なる部分です。

あなたがMarkdownを使って<br />タグを挿入したい場合は、行を1つまたはそれ以上のスペースで終わって、 改行してください。

そうです、<br />を作成するには少しばかり努力が必要ですが、単純に「全ての改行は<br />に変換」 というルールはMarkdownでは働きません。Markdownのemailスタイル引用と複数段落のリスト項目は、 ハードブレークのフォーマットを行う時に、最も良く動作し、見栄えが良くなります。

Markdownは、Setextatx の2つのヘッダスタイルをサポートします。

Setextスタイルヘッダは、 イコールサイン (第一レベルヘッダ) とダッシュ (第二レベルヘッダ) を使用して「下線」を引きます。例えば:

これは H1 です。

=============



これは H2 です。

-------------

下線は = の数に関わらず表示されます。

Atxスタイルのヘッダは、ヘッダレベル1~6に応じて1~6のハッシュキャラクタを行頭で使用します。例えば:

# これは H1 です。



## これは H2 です。



###### これは H6 です。

Atxスタイルヘッダを「閉じる」こともできます。これは純粋に装飾的なものです - 見た目が良くなる場合は使ってください。ハッシュの数はヘッダを開始する時に使用するハッシュの数に合致する必要はありません。( ヘッダを開始する時のハッシュ数は、ヘッダレベルを決定します。):

# これは H1 です。 #



## これは H2 です。 ##



### これは H3 です。 ######

引用

Markdownでは、E-メールと同じように > を引用に使用します。 もし、あなたがメールメッセージの引用に慣れているのでしたら、Markdownでどのように引用を作成すればよいか分かるでしょう。 ハードラップにして、各行の前に > を付けることで見栄えが最良になります:

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,

> consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.

> Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

> 

> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse

> id sem consectetuer libero luctus adipiscing.

Markdownでは、ハードラップした段落の最初の行のみに > コードを付けることもできます:

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,

consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.

Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.



> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse

id sem consectetuer libero luctus adipiscing.

更に > コードを付けることで、引用をネスト ( 例 引用の中の引用 ) することができます:

> これは最初の階層の引用です。

>

> > これはネストした引用です。

>

> 最初の階層に戻ります。

引用は、ヘッダー、リスト、コードブロック等、他のMarkdown要素を含むことができます:

> ## これはヘッダーです。

> 

> 1.   これは最初のリスト項目です。

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

> 

> サンプルコードです:

> 

>     return shell_exec("echo $input | $markdown_script");

優れたテキストエディタでは、どれでもE-メールスタイルの引用を簡単に付けることができます。 例えば、BBEditではテキストを選択して、テキストメニューより引用の階層レベルを増やすことができます。

リスト

Markdownは、番号付きリスト(番号) と 番号無しリスト(黒丸) をサポートします。

番号無しリストは、アスタリスク、プラス、ハイフンのどれかで記述します:

*   赤

*   緑

*   青

は下記と同じです:

+   赤

+   緑

+   青

そして下記とも同じです:

-   赤

-   緑

-   青

Ordered lists use numbers followed by periods:

1.  Bird

2.  McHale

3.  Parish

It’s important to note that the actual numbers you use to mark the list have no effect on the HTML output Markdown produces. The HTML Markdown produces from the above list is:

<ol>

<li>Bird</li>

<li>McHale</li>

<li>Parish</li>

</ol>

If you instead wrote the list in Markdown like this:

1.  Bird

1.  McHale

1.  Parish

or even:

3. Bird

1. McHale

8. Parish

you’d get the exact same HTML output. The point is, if you want to, you can use ordinal numbers in your ordered Markdown lists, so that the numbers in your source match the numbers in your published HTML. But if you want to be lazy, you don’t have to.

If you do use lazy list numbering, however, you should still start the list with the number 1. At some point in the future, Markdown may support starting ordered lists at an arbitrary number.

List markers typically start at the left margin, but may be indented by up to three spaces. List markers must be followed by one or more spaces or a tab.

To make lists look nice, you can wrap items with hanging indents:

*   Lorem ipsum dolor sit amet, consectetuer adipiscing elit.

    Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,

    viverra nec, fringilla in, laoreet vitae, risus.

*   Donec sit amet nisl. Aliquam semper ipsum sit amet velit.

    Suspendisse id sem consectetuer libero luctus adipiscing.

But if you want to be lazy, you don’t have to:

*   Lorem ipsum dolor sit amet, consectetuer adipiscing elit.

Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi,

viverra nec, fringilla in, laoreet vitae, risus.

*   Donec sit amet nisl. Aliquam semper ipsum sit amet velit.

Suspendisse id sem consectetuer libero luctus adipiscing.

If list items are separated by blank lines, Markdown will wrap the items in <p> tags in the HTML output. For example, this input:

*   Bird

*   Magic

will turn into:

<ul>

<li>Bird</li>

<li>Magic</li>

</ul>

But this:

*   Bird



*   Magic

will turn into:

<ul>

<li><p>Bird</p></li>

<li><p>Magic</p></li>

</ul>

List items may consist of multiple paragraphs. Each subsequent paragraph in a list item must be intended by either 4 spaces or one tab:

1.  This is a list item with two paragraphs. Lorem ipsum dolor

    sit amet, consectetuer adipiscing elit. Aliquam hendrerit

    mi posuere lectus.



    Vestibulum enim wisi, viverra nec, fringilla in, laoreet

    vitae, risus. Donec sit amet nisl. Aliquam semper ipsum

    sit amet velit.



2.  Suspendisse id sem consectetuer libero luctus adipiscing.

It looks nice if you indent every line of the subsequent paragraphs, but here again, Markdown will allow you to be lazy:

*   This is a list item with two paragraphs.



    This is the second paragraph in the list item. You're

only required to indent the first line. Lorem ipsum dolor

sit amet, consectetuer adipiscing elit.



*   Another item in the same list.

To put a blockquote within a list item, the blockquote’s > delimiters need to be indented:

*   A list item with a blockquote:



    > This is a blockquote

    > inside a list item.

To put a code block within a list item, the code block needs to be indented twice — 8 spaces or two tabs:

*   A list item with a code block:



        <code goes here>

It’s worth noting that it’s possible to trigger an ordered list by accident, by writing something like this:

1986. What a great season.

In other words, a number-period-space sequence at the beginning of a line. To avoid this, you can backslash-escape the period:

1986\. What a great season.

Code Blocks

Pre-formatted code blocks are used for writing about programming or markup source code. Rather than forming normal paragraphs, the lines of a code block are interpreted literally. Markdown wraps a code block in both <pre> and <code> tags.

To produce a code block in Markdown, simply indent every line of the block by at least 4 spaces or 1 tab. For example, given this input:

This is a normal paragraph:



    This is a code block.

Markdown will generate:

<p>This is a normal paragraph:</p>



<pre><code>This is a code block.

</code></pre>

One level of indentation — 4 spaces or 1 tab — is removed from each line of the code block. For example, this:

Here is an example of AppleScript:



    tell application "Foo"

        beep

    end tell

will turn into:

<p>Here is an example of AppleScript:</p>



<pre><code>tell application "Foo"

    beep

end tell

</code></pre>

A code block continues until it reaches a line that is not indented (or the end of the article).

Within a code block, ampersands (&) and angle brackets (< and >) are automatically converted into HTML entities. This makes it very easy to include example HTML source code using Markdown — just paste it and indent it, and Markdown will handle the hassle of encoding the ampersands and angle brackets. For example, this:

    <div class="footer">

        &copy; 2004 Foo Corporation

    </div>

will turn into:

<pre><code>&lt;div class="footer"&gt;

    &amp;copy; 2004 Foo Corporation

&lt;/div&gt;

</code></pre>

Regular Markdown syntax is not processed within code blocks. E.g., asterisks are just literal asterisks within a code block. This means it’s also easy to use Markdown to write about Markdown’s own syntax.

Horizontal Rules

You can produce a horizontal rule tag (<hr />) by placing three or more hyphens or asterisks on a line by themselves. If you wish, you may use spaces between the hyphens or asterisks. Each of the following lines will produce a horizontal rule:

* * *



***



*****



- - -



---------------------------------------


Span Elements

Markdown supports two style of links: inline and reference.

In both styles, the link text is delimited by [square brackets].

To create an inline link, use a set of regular parentheses immediately after the link text’s closing square bracket. Inside the parentheses, put the URL where you want the link to point, along with an optional title for the link, surrounded in quotes. For example:

This is [an example](http://example.com/ "Title") inline link.



[This link](http://example.net/) has no title attribute.

Will produce:

<p>This is <a href="http://example.com/" title="Title">

an example</a> inline link.</p>



<p><a href="http://example.net/">This link</a> has no

title attribute.</p>

If you’re referring to a local resource on the same server, you can use relative paths:

See my [About](/about/) page for details.

Reference-style links use a second set of square brackets, inside which you place a label of your choosing to identify the link:

This is [an example][id] reference-style link.

You can optionally use a space to separate the sets of brackets:

This is [an example] [id] reference-style link.

Then, anywhere in the document, you define your link label like this, on a line by itself:

[id]: http://example.com/  "Optional Title Here"

That is:

  • Square brackets containing the link identifier (optionally indented from the left margin using spaces or tabs);
  • followed by a colon;
  • followed by one or more spaces (or tabs);
  • followed by the URL for the link;
  • optionally followed by a title attribute for the link, enclosed in double or single quotes.

The link URL may, optionally, be surrounded by angle brackets:

[id]: <http://example.com/>  "Optional Title Here"

You can put the title attribute on the next line and use extra spaces or tabs for padding, which tends to look better with longer URLs:

[id]: http://example.com/longish/path/to/resource/here

    "Optional Title Here"

Link definitions are only used for creating links during Markdown processing, and are stripped from your document in the HTML output.

Link definition names may constist of letters, numbers, spaces, and punctuation — but they are not case sensitive. E.g. these two links:

[link text][a]

[link text][A]

are equivalent.

The implicit link name shortcut allows you to omit the name of the link, in which case the link text itself is used as the name. Just use an empty set of square brackets — e.g., to link the word “Google” to the google.com web site, you could simply write:

[Google][]

And then define the link:

[Google]: http://google.com/

Because link names may contain spaces, this shortcut even works for multiple words in the link text:

Visit [Daring Fireball][] for more information.

And then define the link:

[Daring Fireball]: http://daringfireball.net/

Link definitions can be placed anywhere in your Markdown document. I tend to put them immediately after each paragraph in which they’re used, but if you want, you can put them all at the end of your document, sort of like footnotes.

Here’s an example of reference links in action:

I get 10 times more traffic from [Google] [1] than from

[Yahoo] [2] or [MSN] [3].



  [1]: http://google.com/        "Google"

  [2]: http://search.yahoo.com/  "Yahoo Search"

  [3]: http://search.msn.com/    "MSN Search"

Using the implicit link name shortcut, you could instead write:

I get 10 times more traffic from [Google][] than from

[Yahoo][] or [MSN][].



  [google]: http://google.com/        "Google"

  [yahoo]:  http://search.yahoo.com/  "Yahoo Search"

  [msn]:    http://search.msn.com/    "MSN Search"

Both of the above examples will produce the following HTML output:

<p>I get 10 times more traffic from <a href="http://google.com/"

title="Google">Google</a> than from

<a href="http://search.yahoo.com/" title="Yahoo Search">Yahoo</a>

or <a href="http://search.msn.com/" title="MSN Search">MSN</a>.</p>

For comparison, here is the same paragraph written using Markdown’s inline link style:

I get 10 times more traffic from [Google](http://google.com/ "Google")

than from [Yahoo](http://search.yahoo.com/ "Yahoo Search") or

[MSN](http://search.msn.com/ "MSN Search").

The point of reference-style links is not that they’re easier to write. The point is that with reference-style links, your document source is vastly more readable. Compare the above examples: using reference-style links, the paragraph itself is only 81 characters long; with inline-style links, it’s 176 characters; and as raw HTML, it’s 234 characters. In the raw HTML, there’s more markup than there is text.

With Markdown’s reference-style links, a source document much more closely resembles the final output, as rendered in a browser. By allowing you to move the markup-related metadata out of the paragraph, you can add links without interrupting the narrative flow of your prose.

Emphasis

Markdown treats asterisks (*) and underscores (_) as indicators of emphasis. Text wrapped with one * or _ will be wrapped with an HTML <em> tag; double *’s or _’s will be wrapped with an HTML <strong> tag. E.g., this input:

*single asterisks*



_single underscores_



**double asterisks**



__double underscores__

will produce:

<em>single asterisks</em>



<em>single underscores</em>



<strong>double asterisks</strong>



<strong>double underscores</strong>

You can use whichever style you prefer; the lone restriction is that the same character must be used to open and close an emphasis span.

Emphasis can be used in the middle of a word:

un*fucking*believable

But if you surround an * or _ with spaces, it’ll be treated as a literal asterisk or underscore.

To produce a literal asterisk or underscore at a position where it would otherwise be used as an emphasis delimiter, you can backslash escape it:

\*this text is surrounded by literal asterisks\*

Code

To indicate a span of code, wrap it with backtick quotes (`). Unlike a pre-formatted code block, a code span indicates code within a normal paragraph. For example:

Use the `printf()` function.

will produce:

<p>Use the <code>printf()</code> function.</p>

To include a literal backtick character within a code span, you can backslash escape it:

`There is a literal backtick (\`) here.`

Or, if you prefer, you can use multiple backticks as the opening and closing delimiters:

``There is a literal backtick (`) here.``

Both of the previous two examples will produce this:

<p><code>There is a literal backtick (`) here.</code></p>

With a code span, ampersands and angle brackets are encoded as HTML entities automatically, which makes it easy to include example HTML tags. Markdown will turn this:

Please don't use any `<blink>` tags.

into:

<p>Please don't use any <code>&lt;blink&gt;</code> tags.</p>

You can write this:

`&#8212;` is the decimal-encoded equivalent of `&mdash;`.

to produce:

<p><code>&amp;#8212;</code> is the decimal-encoded

equivalent of <code>&amp;mdash;</code>.</p>

Images

Admittedly, it’s fairly difficult to devise a “natural” syntax for placing images into a plain text document format.

Markdown uses an image syntax that is intended to resemble the syntax for links, allowing for two styles: inline and reference.

Inline image syntax looks like this:

![Alt text](/path/to/img.jpg)



![Alt text](/path/to/img.jpg "Optional title")

That is:

  • An exclamation mark: !;
  • followed by a set of square brackets, containing the alt attribute text for the image;
  • followed by a set of parentheses, containing the URL or path to the image, and an optional title attribute enclosed in double or single quotes.

Reference-style image syntax looks like this:

![Alt text][id]

Where “id” is the name of a defined image reference. Image references are defined using syntax identical to link references:

[id]: url/to/image  "Optional title attribute"

As of this writing, Markdown has no syntax for specifying the dimensions of an image; if this is important to you, you can simply use regular HTML <img> tags.


Miscellaneous

Markdown supports a shortcut style for creating “automatic” links for URLs and email addresses: simply surround the URL or email address with angle brackets. What this means is that if you want to show the actual text of a URL or email address, and also have it be a clickable link, you can do this:

<http://example.com/>

Markdown will turn this into:

<a href="http://example.com/">http://example.com/</a>

Automatic links for email addresses work similarly, except that Markdown will also perform a bit of randomized decimal and hex entity-encoding to help obscure your address from address-harvesting spambots. For example, Markdown will turn this:

<address@example.com>

into something like this:

<a href="&#x6D;&#x61;i&#x6C;&#x74;&#x6F;:&#x61;&#x64;&#x64;&#x72;&#x65;

&#115;&#115;&#64;&#101;&#120;&#x61;&#109;&#x70;&#x6C;e&#x2E;&#99;&#111;

&#109;">&#x61;&#x64;&#x64;&#x72;&#x65;&#115;&#115;&#64;&#101;&#120;&#x61;

&#109;&#x70;&#x6C;e&#x2E;&#99;&#111;&#109;</a>

which will render in a browser as a clickable link to “address@example.com”.

(This sort of entity-encoding trick will indeed fool many, if not most, address-harvesting bots, but it definitely won’t fool all of them. It’s better than nothing, but an address published in this way will probably eventually start receiving spam.)

Backslash Escapes

Markdown allows you to use backslash escapes to generate literal characters which would otherwise have special meaning in Markdown’s formatting syntax. For example, if you wanted to surround a word with literal asterisks (instead of an HTML <em> tag), you can backslashes before the asterisks, like this:

\*literal asterisks\*

Markdown provides backslash escapes for the following characters:

\   backslash

`   backtick

*   asterisk

_   underscore

{}  curly braces

[]  square brackets

()  parentheses

#   hash mark

.   dot

!   exclamation mark

全ヘルプファイルのインデックス