Markdown

Markdown の基本文法を説明する。

概要

Markdown はテキストベースのマークアップ言語である。README、オンラインドキュメント、プレーンテキストエディターで編集する文書などに使われる。Markdown 文書は HTML などの形式へ変換できる。John Gruber が 2004 年に、読み書きしやすいプレーンテキスト形式として作成した。

Markdown

ロゴは Dustin Curtis が作成した。

文法

見出し

1 個から 6 個のハッシュ記号(#)で見出しを表す。

# H1
## H2
### H3

引用

引用には > を使用する。

> This is a blockquote.

リスト

順序なしリストには *+-、順序付きリストには数字を使用する。

- one
- two

1. one
2. two

水平線

3 個以上のハイフン、アスタリスク、アンダースコアを使用する。

***

強調

*italic*
**bold**
~~strikethrough~~

リンクと画像

[Google](https://www.google.com)
![Alt text](/logo/64x64.png "Optional title")

インラインコードとコードブロック

インラインコードにはバッククォート、コードブロックには 3 個のバッククォートを使用する。

`code`

```java
String str = "this is a code block";
```

バックスラッシュによるエスケープ

Markdown の記号をそのまま表示するには、前にバックスラッシュを付ける。

\   backslash
`   backtick
*   asterisk
_   underscore
{}  curly braces
[]  square brackets
()  parentheses
#   hash mark
+   plus sign
-   hyphen
.   dot
!   exclamation mark

拡張文法

脚注

脚注は元の Markdown 仕様には含まれないが、多くの拡張 Markdown 実装で利用できる。

This is a footnote reference.[^footnote]

[^footnote]: This is the footnote.

参考