アテンションの記法

MkDocsでマークダウンでドキュメントを書く際の、ちょっとしたアクセント（アテンション）についてまとめます。

mkdosc.ymlにこのように追記しておきます。

markdown_extensions:
    - admonition

そして設置するMarkdownファイル内で以下のように記述すると、アテンションになります。

ちょっと注釈を付けたい時なんかに便利ですね。

!!! Note
    ちょっとした注釈。

Note

ちょっとした注釈。

Note

ちょっとした注釈。

<?php phpinfo(); ?>

このように、Note内でコードなどの記述も可能です。

冒頭に概要を表記するとかに良いかもです。

!!! summary
    これは概要です。こんにちは。

Summary

これは概要です。こんにちは。

ちょっとワンポイントでドヤ感を出したい時に使えます。

!!! Tip
    ちょっとしたヒントの記述。

Tip

ちょっとしたヒントの記述。

こう書かれるとオチオチ悪いこともできませんね。

!!! Warning
    うっかり二度寝するとあっという間に１時間とか経過します。

Warning

うっかり二度寝するとあっという間に１時間とか経過します。

危険が危ない時に使いましょう。おっかないコマンドとかの注意に良いかもしれません。

!!! Danger
    実行には十分気をつけて！

Danger

実行には十分気をつけて！

いまいち使いどころわからないけど、成功と失敗を表記できます。

!!! Success
    やったぜ大成功

!!! Failure
    残念無念、また来週。

Success

やったぜ大成功

Failure

残念無念、また来週。

これも使いどころが微妙にわからない気がするけど、バグを表記できます。

!!! Bug
    バグですね。困った。

Bug

バグですね。困った。