Alerts拡張機能

重要な文章を目立つように表示します

taiseiue | 2024-03-11
  • 共有
  •  記事の編集

対応バージョン:>=2.9.4

Alerts拡張機能は、Lantanaにアラートを追加する拡張機能です。

この拡張機能を有効化することで、以下のコンポーネントが使用できるようになります。

  • アラート

使用方法

目を引く形で説明したい場合、!!! 種類 "タイトル"で囲みます。

Markdown
!!! note "メモ"
    `note`で使用できる装飾です。[リンク](#)は自動的に適切な色になります。

結果

メモ

noteで使用できる装飾です。リンクは自動的に適切な色になります。

Abstract

abstractで使用できる装飾です。リンクは自動的に適切な色になります。

Info

infoで使用できる装飾です。リンクは自動的に適切な色になります。

Tip

tipで使用できる装飾です。リンクは自動的に適切な色になります。

Important

importantで使用できる装飾です。リンクは自動的に適切な色になります。

Caution

cautionで使用できる装飾です。リンクは自動的に適切な色になります。

Success

successで使用できる装飾です。リンクは自動的に適切な色になります。

Question

questionで使用できる装飾です。リンクは自動的に適切な色になります。

Warning

warningで使用できる装飾です。リンクは自動的に適切な色になります。

Failure

failureで使用できる装飾です。リンクは自動的に適切な色になります。

Danger

dangerで使用できる装飾です。リンクは自動的に適切な色になります。

Bug

bugで使用できる装飾です。リンクは自動的に適切な色になります。

Example

exampleで使用できる装飾です。リンクは自動的に適切な色になります。

Quote

quoteで使用できる装飾です。リンクは自動的に適切な色になります。

アラートのネスト

アラート内にアラートを含めることもできます。

Markdown
!!! note "メモ"
    !!! info
        `info`で使用できる装飾です。[リンク](#)は自動的に適切な色になります。

結果

メモ

Info

infoで使用できる装飾です。リンクは自動的に適切な色になります。

導入方法

設定ファイル(mkdocs.yml)に以下の行を追加します。

mkdocs.yml
markdown_extensions:
      (中略)
    - lantana.alerts

このとき、alertsはsuperfencesより後に追加してください。