Markdownで書く

はじめに

Markdownはマークアップ言語の一種で、簡単な記法で構造化されたドキュメントを書くことができます。

Markdownには最も基本となる「原典の記法」がありますが、それは非常に限られた機能を持つものであるため、Markdownプロセッサはそれぞれが独自の拡張を施しています。結果としては、Markdownには様々な「方言」が生まれています。

ほとんどの場合、オリジナルの記法はどのMarkdownプロセッサでも使うことができます。 PureBuilder Simplyは様々なドキュメントプロセッサを使うことができるため、有効な記法は使用するドキュメントプロセッサと設定によって異なります。

ここでの出力サンプルは基本的に、Pandocを用いて生成しています。

空行をはさんだテキストは段落になります。

空行ではない改行は、一般的にただのホワイトスペースとして扱われます。 HTMLでは改行もただのホワイトスペースとして扱われるため、HTMLに変換する最には改行は改行のままになり、<br>には変換されないのが普通です。

段落
その1

段落その2

<p>段落 その1</p>
<p>段落その2</p>

#とスペースで始まる行は見出しになります。 #の数が見出しレベルになり、#ならh1に、##ならh2になります。

ドキュメントプロセッサの機能によっては、この対応関係をオフセットすることもできます。

# 見出し1

段落その1

<h1 id="見出し1">見出し1</h1>
<p>段落その1</p>

[リンクテキスト](URL)の形式でリンクを貼ることができます。

[PureBuilder Simply](https://github.com/reasonset/purebuilder-simply)

<p><a href="https://github.com/reasonset/purebuilder-simply">PureBuilder
Simply</a></p>

![テキスト](URL)の形式で画像を貼ることができます。

テキストは通常、img要素のalt属性になります。 Pandocでは単独の画像からなる段落はfigureと組み合わせられます。

This is ![Logo](/img/logo.png)

<p>This is <img src="/img/logo.png" alt="Logo" /></p>

>とスペースで始まる行からなる段落は引用であるとみなされます。

What is PureBuilder

> PureBuilder is website building script.

<p>What is PureBuilder</p>
<blockquote>
<p>PureBuilder is website building script.</p>
</blockquote>

*とスペースで始まる行で構成される段落は、箇条書きになります。

* その1
* その2
* その3

<ul>
<li>その1</li>
<li>その2</li>
<li>その3</li>
</ul>

4つのスペースでインデントすると箇条書きを入れ子にすることができます。

* その1
    * その1-1
    * その1-2
* その2

*のほかに-や+を使うこともできますが、Markdownプロセッサによっては対応していないかもしれません。

* その1
    - その1-1
    - その1-2
* その2

数値とスペースで始まる行で構成される段落は、順序つき箇条書きになります。

1. その1
1. その2
1. その3

<ol type="1">
<li>その1</li>
<li>その2</li>
<li>その3</li>
</ol>

1., 2., 3.のように書いても構いませんが、そうしなければいけないわけではありません。

*で囲まれたテキストはem相当の強調になります。

これは *強調* です。

<p>これは <em>強調</em> です。</p>

**で囲まれたテキストはstrong相当の強調になります。

これは **強い強調** です。

<p>これは <strong>強い強調</strong> です。</p>

バッククォートで囲まれたテキストは、コード文字列として扱われます。

Pandocのコマンドは `pandoc` です。

<p>Pandocのコマンドは <code>pandoc</code> です。</p>

3つ以上のバッククォートの行で囲まれたテキストはコードブロックとして扱われます。 HTMLにはコードブロックを表す要素がないため、code要素とブロック要素、あるいはpre要素を組み合わせて表現されます。

```
echo Hello, world.
```

<pre><code>echo Hello, world.</code></pre>