Markdown の基礎

Markdown とは

Grav では基本的に Markdown（マークダウン）で記事を書きます。Markdown は（名前こそ "ダウン" ですが）マークアップ言語のひとつで，HTML との相互変換を念頭に置いて考えられています。

Markdown を使うことで，構造化された文書を簡単に書くことができます。

このページでは，Grav で使える Markdown 記法の基礎を紹介します。Grav に同梱されているサンプルページの説明が簡潔で良かったので，それをベースにします。

いろいろな Markdown 記法

見出し (Headings)

Heading は見出しであり，HTML では以下のように書きます。

<h1>タイトル</h1>
<h2>見出し</h2>
<h3>小見出し</h3>
...

HTML ではタグで括る必要があるので面倒ですが，Markdown ではテキストの前に # を付けることで実現できます。

最初の H1 では # はひとつだけ，入れ子構造で見出しが細分化するにつれて増やしていきます。

以下のように書けば，

# H1 Heading `40px`

## H2 Heading `32px`

### H3 Heading `28px`

#### H4 Heading `24px`

##### H5 Heading `20px`

###### H6 Heading `16px`

このように表現されます。

H1 Heading 40px

H2 Heading 32px

H3 Heading 28px

H4 Heading 24px

H5 Heading 20px
H6 Heading 16px

段落

Markdown では，前後に空白の行があれば段落として解釈され，<p>タグで括られます。

Markdown セマンティック要素

基本的な要素は Markdown で手軽に書けます。

太字 **太字**

斜体 _斜体_

打ち消し ~~打ち消し~~

インラインコード `インラインコード`

HTML セマンティック要素

HTML のタグを使うことも出来ます。見た目に反映されるかはテーマによります。

I18N <abbr>I18N</abbr>　略語

Citation <cite>Citation</cite>　引用

Ctrl + S <kbd>Ctrl + S</kbd>　キーボード

TextSuperscripted Text<sup>Superscripted</sup>　上付き文字

TextSubscripted Text<sub>Subscripted</sub>Text<sub>Subscripted</sub>　下付き文字

Underlined <u>Underlined</u>　下線

Highlighted <mark>Highlighted</mark>　強調

<time>20:14</time>　時刻

x = y + 2 <var>x = y + 2</var>　変数

ブロック引用（Blockquote）

The advance of technology is based on making it fit in so that you don't really even notice it, so it's part of everyday life.

Bill Gates

> The advance of technology is based on making it fit in so that you don't really even notice it,
> so it's part of everyday life.
>
> <cite>Bill Gates</cite>

順序付けしないリスト

* を使いますが，- も使えます。

  • list item 1
  • list item 2
    • list item 2.1
    • list item 2.2
    • list item 2.3
  • list item 3
* list item 1
* list item 2
    * list item 2.1
    * list item 2.2
    * list item 2.3
* list item 3

順序付けするリスト

すべて 1. で始めても Grav が表示の際に自動で順序を整理してくれます。Admin Panel で記事を書く際にはエディタがその場で整理してくれます。

  1. list item 1
  2. list item 2
    1. list item 2.1
    2. list item 2.2
    3. list item 2.3
  3. list item 3
1. list item 1
1. list item 2
    1. list item 2.1
    1. list item 2.2
    1. list item 2.3
1. list item 3

表

Name Genre Release date
The Shawshank Redemption Crime, Drama 14 October 1994
The Godfather Crime, Drama 24 March 1972
Schindler's List Biography, Drama, History 4 February 1994
Se7en Crime, Drama, Mystery 22 September 1995 
| Name                        | Genre                         | Release date         |
| :-------------------------- | :---------------------------: | -------------------: |
| The Shawshank Redemption    | Crime, Drama                  | 14 October 1994      |
| The Godfather               | Crime, Drama                  | 24 March 1972        |
| Schindler's List            | Biography, Drama, History     | 4 February 1994      |
| Se7en                       | Crime, Drama, Mystery         | 22 September 1995    |

「通知」

「通知」スタイルは実際には markdown-notices プラグインの機能ですが，このプラグインは Grav に標準でバンドルされています。

色だと赤い !! が一番重大そうですが黄色い ! が一番重要ぽく，いまいち使いにくいです。

まあ Grav 独自の拡張に過ぎないみたいなので，このサイトでは !! を警告（やばいぞ），! を注意（要確認）の意味で使っています。

警告通知

エラー通知

標準通知

成功通知

! 警告通知

!! エラー通知

!!! 標準通知

!!!! 成功通知
紹介する：