返回知识库

工程与栈 · 开发基础

MarkdownMarkdown

用 #、-、**、反引号、[]() 在纯文本里写结构,渲染器再把它变成带标题和列表的文章;源稿本身就可读。

先认出这篇 README,再改源稿符号

下面就是仓库里渲染后的说明:默认已有标题和列表。点「塞进 script」,标签变成纯文本;失败也写在同一篇文章上。

README.md · 周末徒步已渲染 · 符号即结构

周末徒步

下午两点出发,带足够的水

  • 爬山
  • 拍照
  • 一起晚餐

已渲染 · 符号即结构标题和列表长在这篇 README 上。

原因:# 写成标题、- 写成列表、** 写成加粗,渲染器把它变成文章。下一步:试「塞进 script」,看危险标签会不会跑。

知识点:符号即结构

文章上的标题和转义行已经演示了规则,这里只命名。

  • 符号即结构:# 写标题、- 写列表、** 写加粗、反引号写代码、[]() 写链接。
  • 源稿可读:没有渲染器时仍是一段能读的纯文本,diff 和搜索都按文本走。
  • 渲染分离:同一份源稿在网页、编辑器、聊天里都能变成文章。
  • 安全靠渲染器:原始 HTML 和脚本默认被转义,不当作可执行内容。

什么时候用、怎么用

内容要被反复改、还要在多处一致显示时用 Markdown。

  • 信号:写 README、知识库、评论,想要标题和列表但不想碰 HTML。
  • 适用:项目文档、发布说明、聊天里的加粗和链接。
  • 不适用:精确像素排版或必须跑脚本的页面,应直接写 HTML/CSS。
  • 最短路径:认结构 → 贴符号 → 空行分隔块 → 预览后再发布。

正反例:同一篇发布说明

目标都是让说明有标题和列表,只改结构用符号还是裸 HTML。

正例# 发布说明 加上 - 修复登录

源稿可读、可 diff,渲染后是标题和列表。

反例把 <script> 或大段 HTML 塞进源稿

源稿不可读,还有 XSS 风险。失败写在文章里那行转义标签上。

快速自测

评论里想强调一句话并带一个外部链接,最合适的写法是?

继续查证

术语的技术定义和行为以这些一手或权威资料为准。

下一步学

和本知识点经常一起出现的概念。