Markdown 記法まとめ

Markdownの学習もかねて、Markdownの記法をいくつかまとめてみました。

見出し

テキストの手前に#をつけて記述。
#の数でテキストのサイズが変わる。最大で6個。

・書き方例

# 見出しh1
## 見出しh2
### 見出しh3
#### 見出しh4
##### 見出しh5
###### 見出しh6

・結果

見出しh1

見出しh2

見出しh3

見出しh4

見出しh5

見出しh6

箇条書きリスト

テキストの手前に+ * -のいずれかをつけて記述。
インデントはタブで下げられる。

・書き方例

+ テキスト
    + テキスト
    - テキスト
    * テキスト

・結果

• テキスト
  • テキスト
  • テキスト
  • テキスト

番号付きリスト

テキストの手前に数値と.で記述。
実際に表示される際には適切な数値が振られるので、記述時の数値は何でもいい。

・書き方例

1. テキスト
    1. テキスト
    1. テキスト
    1. テキスト

・結果

1. テキスト
   1. テキスト
   2. テキスト
   3. テキスト

#　改行、空行

文末に半角スペース2つで改行、<br>で空行を記述。

・書き方例

テキスト␣␣　←半角スペース2つ
テキスト
<br>
テキスト

・結果

テキスト
テキスト


テキスト

インライン表記

テキストを``で囲むことで記述。

・書き方例

``text``

・結果

囲んだ部分がtextのように表示されます。

pre記法

文頭にスペース4つかタブで記述。

・書き方例

	// Tab
	int a = 0;
		int b = 0;

    // Space
    int a = 0;
        int b = 0;

・結果

int a = 0;
    int b = 0;

pre記法 ( ``` , ~~~ )

```や~~~ で囲うことでも記述可能。
また、以下の例のように記述することで、シンタックスハイライトとタイトル付けを行える。

・書き方例

    ~~~言語名:タイトル
        テキスト
    ~~~

    ```golang:example.go
        packege "main"
        
        import "fmt"

        func main() {
            fmt.Println("Hello World!")
        }
    ```

・結果

example.go

    packege "main"
        
    import "fmt"

    func main() {
        fmt.Println("Hello World!")
    }

引用

テキストの手前に>で記述。>>で二重引用になる。

・書き方例

> テキスト
>
> テキスト
>> テキスト
>> テキスト

・結果

テキスト

テキスト

テキスト
テキスト

リンクの挿入

[リンク名](URL)で記述。

・書き方例

[Qiita](https://qiita.com/)

・結果

・Qiita

定義参照リンク

文中にいちいち長いURLを書いてると可読性が悪いので、先に定義しておく方法。
[定義する名前]: URLで定義し、参照する際は[リンク名][定義した名前]と記述。

・書き方例

    [Qiitaに飛べます][qiita]

    [qiita]: https://qiita.com/

・結果

Qiitaに飛べます

画像の挿入

下の例のように記述。ドラッグ＆ドロップでも可能。

・書き方例

![代替テキスト](URL "タイトル")

![sample_image](https://2.bp.blogspot.com/-BBDUhqUqFxY/WUdZNRQOykI/AAAAAAABFDw/dHO4dZ-5-NQTyXy_8_mpy4c5y-mYlPvFACLcBGAs/s800/pop_gazouha_image_desu_shikaku.png "sample_image")

・結果

・挿入画像:

サイズを指定して画像を挿入

htmlの<img>タグを用いて指定できる。

・書き方例

<img width = "数値" alt = "代替テキスト" src = "URL">

<img width = "150" alt = "sample_image" src = "https://2.bp.blogspot.com/-BBDUhqUqFxY/WUdZNRQOykI/AAAAAAABFDw/dHO4dZ-5-NQTyXy_8_mpy4c5y-mYlPvFACLcBGAs/s800/pop_gazouha_image_desu_shikaku.png">

・結果

テーブルの挿入

入力補完を利用するなら列数x行数で記述できる。
手動の場合は以下の例のように記述。

・書き方例

// 3x2の入力補完で記述されたテーブル
| 1 | 2 | 3 |
|:-:|:-:|:-:|
|   |   |   |
|   |   |   |

// 手動記入例
| left   |   center   |    right |
|:-------|:----------:|---------:|
| left   |   center   |    right |
| `left` | **center** |  *right* |

・結果

1	2	3

left	center	right
left	center	right
left	center	right

強調

_か*で囲むと強調表現になる。1つだと斜体になり、2つだと太字になる。

・書き方例

_text_
*text*

__text__
**text**

・結果

text
text

text
text

取り消し線

~~で囲むことで取り消し線をつけられる。

・書き方例

~~テキスト~~

・結果

テキスト

水平線

*か-か_を3つ以上連続で記述することで表示可能。
スペースは入っていても表示可能。

・書き方例

***
---
___

* * *

・結果

---

---

---

---

注釈

テキスト[^1]と[^1]: 注釈内容で記述。注釈は記述場所に関係なく文末表示となる

・書き方例

    text[^1]
    [^1]: 注釈内容

・結果

text¹

マークダウンのエスケープ

\をつけると可能。

・書き方例

\`インライン表示されない`

・結果

`インライン表示されない`

参考にさせていただいたサイト

• Markdown記法 サンプル集
• Qiita マークダウン記法 一覧表・チートシート
• Markdown記法一覧
• Markdown でバッククオートを含むインラインコードを書くには
• 意外と知られてないっぽいMarkDownのリンクの書き方

1. 注釈内容 ↩