Alerts2拡張機能

重要な文章を目立つように表示します。GFMと互換性があります。


taiseiue | 2024-05-06

対応バージョン:>=2.12.1

Alerts2拡張機能は、Lantanaに引用を使用したアラートを追加する拡張機能です。

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

  • アラート

この拡張機能は、lantana拡張機能に依存しています。 この拡張機能を使用するには、lantana拡張機能の使用が必要です。

使用方法

適用したい引用符の任意の行に[!種類] タイトルを追加します。

Markdown
> [!NOTE] メモ
> 流し読みしているユーザーにも読んでもらいたい情報を記述します。

結果

メモ

流し読みしているユーザーにも読んでもらいたい情報を記述します。

アラートのバリエーション

用途に応じて、アラートには様々な色やアイコンを使用できます。 次に例を示します。

NOTE

Note

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

このアラートはGitHubのアラート記法と互換性があります。

TIP

Tip

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

このアラートはGitHubのアラート記法と互換性があります。

IMPORTANT

Important

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

このアラートはGitHubのアラート記法と互換性があります。

CAUTION

Caution

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

このアラートはGitHubのアラート記法と互換性があります。

WARNING

Warning

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

このアラートはGitHubのアラート記法と互換性があります。

ABSTRACT

Abstract

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

INFO

Info

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

SUCCESS

Success

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

QUESTION

Question

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

FAILURE

Failure

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

DANGER

Danger

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

BUG

Bug

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

EXAMPLE

Example

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

QUOTE

Quote

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

注意事項

この拡張機能は、Alerts拡張機能と異なり、引用を使ってアラートを作成します。 MkDocsのMarkdownは、連続したふたつ以上の引用をひとつの引用として認識します。 このため、この拡張機能で生成されるアラートは、連続して配置できないことにご注意ください。 次の例をご覧ください。

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

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

結果

Tip

Note

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

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

このような結果を避けるには、アラートの間に任意の要素を追加してください。

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

<!-- -->
> [!TIP]
> `TIP`で使用できる装飾です。[リンク](#)は自動的に適切な色になります。

Note

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

Tip

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

アラートのネスト

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

Markdown
> [!NOTE]
> `note`で使用できる装飾です。[リンク](#)は自動的に適切な色になります。
> > ![TIP]
> > これはネストされたアラートです。

結果

Tip

Note

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

これはネストされたアラートです。

導入方法

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

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