跳到正文

Markdown

初级通用

Markdown 是一种用纯文本标记标题、列表、链接等内容结构的写法。它让你不用打开排版工具,也能写出便于阅读和转换的文档,例如项目说明或帮助中心文章。

你可能会说:「我想把项目说明写成普通文本,但展示出来要有标题、列表和链接,还方便以后修改。」

动手看看

渲染结果

新用户开通指南

开通前请准备:

  • 企业邮箱
  • 邀请码
  1. 打开开通页面
  2. 填写资料

帮助中心地址:https://example.com/help

左边是帮助中心文章的纯文本,右边是渲染后的文档。标题、列表和链接靠简单的标记形成结构,不用逐项排版。

试试删掉第一行的 #,看看大标题如何变成普通文字:井号告诉渲染器这一行是标题。

试试把[开通页面](https://example.com/start)改成开通页面,看看链接如何消失;下方的网址也不会自动变成链接。

要点

  1. 1

    写下的是文本和结构线索

    你编辑的仍是纯文本,只是用约定的写法告诉工具哪里是标题、列表或链接。因为内容不依赖某个编辑器,所以团队可以像修改代码一样查看和比较文档的改动。

  2. 2

    展示效果取决于解析工具

    同一份 Markdown 可以在代码平台、文档站或产品页面中呈现,但样式由展示它的工具决定。比如你写了标题层级,页面用什么字号和颜色,还得由网站的样式来控制。

  3. 3

    不同平台支持范围会有差别

    常见的标题、列表和链接通常容易迁移,但表格、任务清单等写法未必处处一致。你让 AI Agent 生成文档时,告诉它最终在哪个平台展示,才能减少复制过去后重新调整的工作。

容易混淆的地方

Markdown 主要负责表达内容结构,不负责精确控制页面外观;要定字号、间距和布局,通常还得靠 CSS。它也不是 HTML:HTML 能描述更多网页元素,而 Markdown 更适合快速写文档。有些工具会把 Markdown 转成 HTML 展示,但两者不是同一种写法。

什么时候用

适合用

  • 和 AI Agent 协作维护项目说明,让安装步骤和注意事项能直接放进代码仓库。
  • 为帮助中心写文章,先整理标题、段落和链接,再交给文档系统展示。
  • 让 AI 工具输出带小标题和列表的回答,方便用户阅读,也方便后续编辑。

不适合用

  • 要制作有复杂布局、交互按钮的产品页面时,用网页组件和 CSS,而不是只靠 Markdown。
  • 要保存供程序严格读取的订单字段或接口数据时,用 JSON 等结构化格式。
  • 要制作需要精确分页、固定版式的打印材料时,用排版工具或适合打印的文档格式。

练一练

你在做产品帮助中心,文章由运营同事维护,页面样式由网站统一控制。该怎样向 AI Agent 描述内容格式?

让 AI 帮你做

请为我的产品帮助中心撰写一篇 Markdown 文章,读者是第一次使用后台的运营同事。用清晰的标题层级组织操作步骤,步骤用列表表达,相关页面留出可替换的链接文字;只写内容结构,不指定字号、颜色或页面布局。

接下来学什么