Alerts2拡張機能
この記事では、Alerts2拡張機能の使用方法について説明します
対応バージョン:>=2.9.8.1
Alerts2拡張機能は、Lantanaに引用を使用したアラートを追加する拡張機能です。
この拡張機能を有効化することで、以下のコンポーネントが使用できるようになります。
- アラート
この拡張機能は、lantana拡張機能に依存しています。 この拡張機能を使用するには、lantana拡張機能の使用が必要です。
使用方法
適用したい引用符の任意の行に[!種類] タイトル
を追加します。
結果
メモ
流し読みしているユーザーにも読んでもらいたい情報を記述します。
アラートのバリエーション
用途に応じて、アラートには様々な色やアイコンを使用できます。 次に例を示します。
NOTE
TIP
IMPORTANT
CAUTION
WARNING
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は、連続したふたつ以上の引用をひとつの引用として認識します。 このため、この拡張機能で生成されるアラートは、連続して配置できないことにご注意ください。 次の例をご覧ください。
> [!NOTE]
> `NOTE`で使用できる装飾です。[リンク](#)は自動的に適切な色になります。
> [!TIP]
> `TIP`で使用できる装飾です。[リンク](#)は自動的に適切な色になります。
結果
このような結果を避けるには、アラートの間に任意の要素を追加してください。
> [!NOTE]
> `NOTE`で使用できる装飾です。[リンク](#)は自動的に適切な色になります。
<!-- -->
> [!TIP]
> `TIP`で使用できる装飾です。[リンク](#)は自動的に適切な色になります。
Note
NOTE
で使用できる装飾です。リンクは自動的に適切な色になります。
Tip
TIP
で使用できる装飾です。リンクは自動的に適切な色になります。
アラートのネスト
アラート内にアラートを含めることもできます。
結果
導入方法
設定ファイル(mkdocs.yml
)に以下の行を追加します。