# 注釈したい

```md
!!! note "注釈したい"
    ここに注釈したい内容を書く。
    複数行にわたる場合は、行末に半角スペースを2つ入れることで改行できる。
    さらに改行したい場合は、行末に半角スペースを2つ入れる。

    - 箇条書きも可能
    - 箇条書きも可能
    - 箇条書きも可能

    > 引用も可能
    > 引用も可能
```

`!!!`のあとにタイプを書くと、色とアイコンのついた注釈ボックスを挿入できます。
`admonition`や`callout`とも呼ばれます。
本文はタイプ行のあと、半角スペース4つ（または1タブ）でインデントします。
`"タイトル"`を省略するとタイプ名がそのままタイトルになり、`""`（空文字）にするとタイトル行が消えます。

タイプにはそれぞれ決まった色系統があります。
エイリアスを使っても色とアイコンは代表タイプと同じになります。

## メモしたい（`note`）

```md
!!! note "メモのタイトル"
    ここにメモの内容を書く。
```

`note`は、汎用的なメモを表示するためのタイプです。
青系です。

## 概要したい（`abstract`）

```md
!!! abstract "概要のタイトル"
    ここに概要の内容を書く。
```

`abstract`は、概要や要約を表示するためのタイプです。
青系です。
`summary`や`tldr`がエイリアスとして使えます。

## 補足したい（`info`）

```md
!!! info "補足のタイトル"
    ここに補足の内容を書く。
```

`info`は、補足情報やToDoを表示するためのタイプです。
`todo`がエイリアスとして使えます。

## ヒントしたい（`tip`）

```md
!!! tip "ヒントのタイトル"
    ここにヒントの内容を書く。
```

`tip`は、ヒントやコツを表示するためのタイプです。
緑系です。
`hint`や`important`がエイリアスとして使えます。

## 成功したい（`success`）

```md
!!! success "成功のタイトル"
    ここに成功の内容を書く。
```

`success`は、成功したケースや推奨される手順を表示するためのタイプです。
緑系です。
`check`や`done`がエイリアスとして使えます。

## 質問したい（`question`）

```md
!!! question "質問のタイトル"
    ここに質問の内容を書く。
```

`question`は、質問や疑問を表示するためのタイプです。
黄系です。
`help`や`faq`がエイリアスとして使えます。

## 警告したい（`warning`）

```md
!!! warning "警告のタイトル"
    ここに警告の内容を書く。
```

`warning`は、注意して読んでほしい内容を表示するためのタイプです。
オレンジ系です。
`caution`や`attention`がエイリアスとして使えます。

## 失敗したい（`failure`）

```md
!!! failure "失敗のタイトル"
    ここに失敗の内容を書く。
```

`failure`は、失敗するケースや避けるべき手順を表示するためのタイプです。
赤系です。
`fail`や`missing`がエイリアスとして使えます。

## 危険したい（`danger`）

```md
!!! danger "危険のタイトル"
    ここに危険の内容を書く。
```

`danger`は、危険な操作や取り返しのつかない操作を表示するためのタイプです。
赤系です。
`error`がエイリアスとして使えます。

## 不具合を示したい（`bug`）

```md
!!! bug "不具合のタイトル"
    ここに不具合の内容を書く。
```

`bug`は、既知のバグや不具合を表示するためのタイプです。
紫系です。

## 具体例したい（`example`）

```md
!!! example "具体例のタイトル"
    ここに具体例の内容を書く。
```

`example`は、使用例やサンプルを表示するためのタイプです。
紫系です。

## 引用したい（`quote`）

```md
!!! quote "引用のタイトル"
    ここに引用の内容を書く。
```

`quote`は、出典のある引用を表示するためのタイプです。
グレー系です。
`cite`がエイリアスとして使えます。

## 折りたたみたい（`???`）

```md
??? note "クリックで開く"
    初期状態は閉じている。

???+ note "最初から開いている"
    展開済みで表示される。
```

`!!!`を`???`にすると折りたたみボックスになります。
初期状態は閉じており、クリックで開きます。
`???+`にすると最初から開いた状態で表示されます。

## リファレンス

- [Admonitions - Material for MkDocs](https://squidfunk.github.io/mkdocs-material/reference/admonitions/)