[[コールアウト]]を利用する。メインは外部向け公開向けのNoteだが、内部向けでも利用できる。 ## 種別と意図 ### Info より詳細な情報や、関連する情報などを記載する。 `例` > [!info] > [[Obsidian]]と比較される対象としては[[Scrapbox]]や[[Roam Research]]などがあります。 ### Hint 読者の知識が想定以下の場合にフォローするために使う。 `例` > [!hint] > [[Markdown]]の書き方は [Qiita マークダウン記法 一覧表・チートシート \- Qiita](https://qiita.com/kamorits/items/6f342da395ad57468ae3) などを見るのが便利。 ### Question なぜ?についての回答を書く。デフォルトは折り畳み状態で、タイトルに概要を書く。 > [!question]- [[コールアウト]]を使うのはなぜか? > 便利だからです。(実際はもっと丁寧な説明や[[内部リンク]]、[[Embed notes]]を使う) ### Unresolved 未解決の問題がある場合に書く。(本筋と逸れる場合で先の流れに問題ない場合のみ) > [!unresolved] > ○○となってしまう問題があるが、原因は不明。 ### Todo あとでやるべきことを書く。 `例` > [!todo] > 最新情報に更新する ### Attention 見逃しても大きな問題がないものはAttentionを使う。 `例` > [!attention] > 本記事は一般向けのものではありません ### Caution 見逃すと**何らかの損失を被る可能性がある**ものはCautionを使う。 `例` > [!caution] > 本記事は最新情報ではありません ### Warning 見逃すと**それなりに大きい損失を被る可能性が高い**ものはWarningを使う。 `例` > [!warning] > 本記事の内容をプロダクションサービスに使わないでください。訴えられる可能性があります ### Danger 見逃すと==必ず大きい損失を被る==ものはDangerを使う。(滅多に使わないと思う) `例` > [!danger] > AWSのsecret keyを公開された場所にアップロードしないでください。1分もしないうちに数百万円にも及ぶ損害が発生します ### Add 追加した事実と時期を明示したい場合に使う。 `例` > [!add] #2023/10/08 追記 > [[Windows]]の[[WSL]]は最高だ ### Trash 削除した事実と時期を明示し、内容を残したい場合に使う。 `例` > [!trash]- #2023/10/07 削除 > [[WSL]]を[[Windows]]で使うのは邪道である。 ### Code ソースコードを書く。デフォルトは折り畳み状態で、タイトルにファイル名を書く。折り畳みが必須な長いコードを表現するときのみ。そうでない場合はコードブロックで表現する。 `例` > [!code]- main.py > ```python > def main(): > print("hoge") > ``` ただし、[[Obsidian]]での編集体験が下がるため、よほど必要でない限りは利用しない方がよい。 ### Positive ポジティブな感情の記録。 > [!positive] 超便利！ ### Negative ネガティブな感情の記録。 > [!negative] 使いにくい... ### Note これまでのいずれにも当てはまらないような情報に使う。 `例` > [!note] > 2022-03-26時点での情報 ## 経緯 - [[💿MIN-0016 注意文言や注釈にコールアウトを使う]] ## 参考 - [注意を表す“warning” と “caution” と “attention” の違いとは？ – スッキリ](https://gimon-sukkiri.jp/warning-caution-attention/)を参考に。