告警语法支持指南

目前 markdown 支持以下三种告警语法:

  • Admonition 类型
  • GitHub 类型
  • Obisidian 类型

Admonition 类型

Admonition 类型:https://lifeinzucc.github.io/help/markdown/admonition/
支持语法:Note,Abstract,Info,Tip,Success,Question,Warning,Failure,Danger,Bug,Example,Quote

渲染前:

    !!! note
        今天风和日丽。

    !!! note "木子日记"
        今天风和日丽。

渲染后:

今天风和日丽。

Jaycee Chow的日记
今天风和日丽。

GitHub 类型

GitHub 类型:https://docs.github.com/zh/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts

渲染前:

    > [!NOTE]
    > 用户即使浏览内容也应该知道的有用信息。

    > [!TIP]
    > 有助于更好或更轻松地完成任务的有用建议。

    > [!IMPORTANT]
    > 用户实现目标所需了解的关键信息。

    > [!WARNING]
    > 紧急信息需要用户立即关注以避免出现问题。

    > [!CAUTION]
    > 针对某些行动的风险或负面结果提出建议。

渲染后:

Useful information that users should know, even when skimming content.

Helpful advice for doing things better or more easily.

Key information users need to know to achieve their goal.

Urgent info that needs immediate user attention to avoid problems.

Advises about risks or negative outcomes of certain actions.

Obisidian 类型

Obsidian 类型:https://plugins.javalent.com/admonitions

渲染前:

    ```ad-note
    title: 笔记
    你好
    ```

    ```ad-seealso
    你好
    ```

    ```ad-abstract
    title: 摘要
    你好
    ```

    ```ad-summary
    你好
    ```

    ```ad-tldr
    你好
    ```

    ```ad-info
    title: 待办事项
    你好
    ```

    ```ad-todo
    你好
    ```

    ```ad-tip
    title: 提示
    你好
    ```

    ```ad-hint
    你好
    ```

    ```ad-important
    你好
    ```

    ```ad-success
    title: 成功
    你好
    ```

    ```ad-check
    你好
    ```

    ```ad-done
    你好
    ```

    ```ad-question
    title: 问题
    你好
    ```

    ```ad-help
    你好
    ```

    ```ad-faq
    你好
    ```

    ```ad-warning
    title: 警告
    你好
    ```

    ```ad-caution
    你好
    ```

    ```ad-attention
    你好
    ```

    ```ad-failure
    title: 失败
    你好
    ```

    ```ad-fail
    你好
    ```

    ```ad-missing
    你好
    ```

    ```ad-danger
    title: 危险
    你好
    ```

    ```ad-error
    你好
    ```

    ```ad-bug
    title: 漏洞
    你好
    ```

    ```ad-example
    title: 例子
    你好
    ```

    ```ad-quote
    title: 引用
    你好
    ```

    ```ad-cite
    你好
    ```

渲染后:

笔记
你好

你好

摘要
你好

你好

你好

待办事项
你好

你好

提示
你好

你好

你好

成功
你好

你好

你好

问题
你好

你好

你好

警告
你好

你好

你好

失败
你好

你好

你好

危险
你好

你好

漏洞
你好

例子
你好

引用
你好

你好

英文说明:

类型 别名
note note, seealso
abstract abstract, summary, tldr
info info, todo
tip tip, hint, important
success success, check, done
question question, help, faq
warning warning, caution, attention
failure failure, fail, missing
danger danger, error
bug bug
example example
quote quote, cite

 

中文对照:

类型 别名
笔记 注意,另请参阅
摘要 摘要、总结、tldr
信息 信息,待办事项
提示 提示,提示,重要
成功 成功,检查,完成
问题 问题、帮助、常见问题解答
警告 警告、小心、注意
失败 失败, 错过
危险 危险、错误
漏洞 漏洞
例子 例子
引用 引述,引用

 

单行代码块:

Python 入门:print 'hello'

Avatar photo

关于 木子

Email: [email protected] 微信:rockylinuxcn QQ: 2306867585
Founder of the Rocky Linux Chinese community, MVP、VMware vExpert、TVP, advocate for cloud native technologies, with over ten years of experience in site reliability engineering (SRE) and the DevOps field. Passionate about Cloud Computing、Microservices、CI&CD、DevOps、Kubernetes, currently dedicated to promoting and implementing Rocky Linux in Chinese-speaking regions.
用一杯咖啡支持我们,我们的每一篇[文档]都经过实际操作和精心打磨,而不是简单地从网上复制粘贴。期间投入了大量心血,只为能够真正帮助到您。
暂无评论

发送评论 编辑评论


				
|´・ω・)ノ
ヾ(≧∇≦*)ゝ
(☆ω☆)
(╯‵□′)╯︵┴─┴
 ̄﹃ ̄
(/ω\)
∠( ᐛ 」∠)_
(๑•̀ㅁ•́ฅ)
→_→
୧(๑•̀⌄•́๑)૭
٩(ˊᗜˋ*)و
(ノ°ο°)ノ
(´இ皿இ`)
⌇●﹏●⌇
(ฅ´ω`ฅ)
(╯°A°)╯︵○○○
φ( ̄∇ ̄o)
ヾ(´・ ・`。)ノ"
( ง ᵒ̌皿ᵒ̌)ง⁼³₌₃
(ó﹏ò。)
Σ(っ °Д °;)っ
( ,,´・ω・)ノ"(´っω・`。)
╮(╯▽╰)╭
o(*////▽////*)q
>﹏<
( ๑´•ω•) "(ㆆᴗㆆ)
😂
😀
😅
😊
🙂
🙃
😌
😍
😘
😜
😝
😏
😒
🙄
😳
😡
😔
😫
😱
😭
💩
👻
🙌
🖕
👍
👫
👬
👭
🌚
🌝
🙈
💊
😶
🙏
🍦
🍉
😣
Source: github.com/k4yt3x/flowerhd
颜文字
Emoji
小恐龙
花!
上一篇