_debris アラート記法について

WIP

随時加筆を行っています

overview

• Github¹やMicrosoft²、Obsidian⁴で採用されているアラート記法を_debrisにも実装する
  • Github, Microsoftの仕様と同様にblockquote構文をベースに実装
  • 本サイトに置いて"WARNING"は不要そうなので、"WARNING"を除いた以下4種に対応する
    • "NOTE", "TIP", "IMPORTANT", "CAUTION"
  • 見出しは記述者が自由に設定できるようにする
• ドキュメント資産の長期運用を見越した際に、死に機能になった場合削除が容易なもの
  • 今は有用だがいずれ無用になる前提で設計を行う

specifications

アラート記法設計

• blockquote内の先頭行に [!NOTE] / [!TIP] / [!IMPORTANT] / [!CAUTION] を記述するとアラートとして扱う
• 種別は note / tip / important / caution の4種
• 先頭行は表示せず、見出し（Note/Tip/Important/Caution）を自動挿入する
• [!NOTE] hogehoge のように ] 以降に文字列を指定した場合は、その文字列を見出しとして使う
• 生成DOMは blockquote.alert.alert-<type> を付与する

基本構文

> [!NOTE]
> ここにテキストを書く

見出し変更

> [!NOTE] ここに見出しを書く
> ここにテキストを書く

種別ごとの用途設計

NOTE

Note

まずよんでね

• ドキュメントを読む前に前提として知るべき情報を掲載するとき
• ドキュメント全体に対してAuthor（僕）がコメントを打ちたいとき
• 熊の戯れ言

TIP

Tip

長文がよめないだろうからヒントをあげるね

• ドキュメントを読む前に知っておくと有用な情報を掲載するとき
• １行まとめ
• 妖精からのツッコミ

IMPORTANT

Important

大事なことなのでいうね

• ドキュメントを読む上で重要なことを掲載するとき
• ランプの精からの有り難いお言葉

CAUTION

Caution

ﾋﾟｻﾞに背を向ける全てのもの 生きるに値しない ﾋﾟｻﾞｰ!!

• ドキュメントを読む上で注意を促したいとき
• ピザの力³を借りたいとき

note

• 今まで<code></code>を使っていたけど、さすがに悪手だった
  • BigTechのスタンダードを拝借できてよかった
• ピザが割と気に入っている