注釈したい(admonition
)
1```{hint}
2これは``hint(ヒント)``型の注釈です。
3```
ヒント
これはhint(ヒント)
型の注釈です。
文章中に注釈を挿入するディレクティブです。
注釈の種類として、attention(注意)
/ caution(注意)
/ danger(危険)
/ error(エラー)
/ hint(ヒント)
/ important(重要)
/ note(注釈)
/ seealso(参考)
/ tip(Tip)
/ warning(警告)
がプリセットされています。
HTMLだと背景色のついたボックス、PDF(=LaTeX)だと、枠に囲まれたボックスで表示されます。
これらのディレクティブは引数を取りませんが、:class:
と:name:
のオプションが使えます。
参考
注釈(admonition
)を使う場合、設定でcolon_fence
とhtml_admonition
を有効にしておくとよいです。
1myst_enable_extensions = [
2 "colon_fence",
3 "html_admonition",
4]
とくにcolon_fence
を有効にすると、```
を:::
で置き換えられるので、
上記のように注釈ディレクティブ(この場合はseealso
)の中でも、いつも通りのMarkdown記法でコードブロックを載せることができます。
注釈にタイトルをつけたい
1:::{admonition} 自由な注釈
2これは自分で好きなタイトルをつけた注釈です。
3:::
自由な注釈
これは自分で好きなタイトルをつけた注釈です。
admonition
ディレクティブを使うと、注意や注釈と表示されるタイトル部分を自分で設定できます。
基本的にはプリセットから選択すれば十分だと思っていますが、こんなこともできると知っているのはよいことだと思います。