微控圈（MCU Loop） - Markdown
type: channel
link: https://www.mculoop.com/tag/Markdown/
items: GitHub Markdown 提示框样式（Note/Tip/Warning）写法
items: Markdown 简介

GitHub Markdown 提示框样式（Note/Tip/Warning）写法
type: item
date: 2026-05-22T10:48:43+00:00
description: 在 GitHub 的 Markdown（GFM）中，实现提示、警告等醒目提示框非常简单，它基于块引用（Blockquote）语法进行了扩展。你只需要掌握一个固定的格式即可。 基本语法格式 核心格式是在块引用的第一行使用特殊标记 [!TYPE]，后续内容正常以 >开头： > [!TYPE] > 这里放你的提示内容，支持**加粗**、*斜体*、`代码`、列表等大部分 Markdown 语法。 注意：[!TYPE] 中的类型关键字（如 NOTE, WARNING）必须大写。 支持的 5 种类型 GitHub 目前官方支持以下 5 种提示类型，它们在渲染时会带有不同的颜色、图标和标题： [!NOTE]（蓝色） 用途：补充说明，用户快速浏览时也应注意的有用信息。 [!TIP]（绿色） 用途：建议或小贴士，帮助用户更轻松或更好地完成操作。 [!IMPORTANT]（紫） 用途：用户达成目标必须知晓的关键信息。 [!WARNING]（黄色/橙色） 用途：急需用户注意的内容，避免潜在问题或风险。 [!CAUTION]（红色） 用途：强烈警告，提示某些动作可能导致负面后果（如数据丢失）。 代码示例： > [!NOTE] > 这是一条补充信息。 > [!TIP] > 这是一个小技巧。 > [!IMPORTANT] > 这是关键信息。 > [!WARNING] > 警告，存在潜在风险。 > [!CAUTION] > 危险操作，请极其小心。 解析效果（取决于解释器）： Note 这是一条补充信息。 Tip 这是一个小技巧。 Important 这是关键信息。 Warning 警告，存在潜在风险。 Caution 危险操作，请极其小心。 使用注意事项 适用范围：支持在 README.md、.md文件、Issues、Pull Requests、Discussions、Gists 中渲染。 内容支持：提示框内部支持完整的 Markdown 语法，包括段落、列表、代码块、图片等。 使用建议：官方建议仅在对用户成功至关重要时才使用，且尽量限制每篇文章 1 - 2 个，避免连续堆叠使用，防止读者视觉疲劳。 兼容性：这是 GitHub 的扩展语法。在不支持该特性的其他 Markdown 渲染器（如某些旧版编辑器）中，它会降级显示为普通的块引用，不会破坏文档结构。

Markdown 简介
type: item
date: 2015-12-15T16:04:00+00:00
description: 什么是 Markdown Markdown 是一种有着纯文本格式化语法的轻量级的标记语言，可以方便地转为 HTML 和其他格式。它是由 John Gruber 在 2004 年创建的。它的目标是让人们使用易读、易写的纯文本格式去写作，将排版、美化等工作交给软件去做。这种专注于写作内容而不是排版的理念，使它在程序员、文字工作者的圈子里火了起来。 [...]