Markdown

一种用简单符号标记文本格式的写法——用

它到底指什么?

Markdown 是一种让你"用纯文本写出格式化文档"的方法。你不需要像 Word 那样点击工具栏上的按钮来设置格式,而是用几个简单的符号来标记:

  • # 大标题## 小标题 表示不同级别的标题
  • **加粗** 让文字变粗
  • - 列表项 生成项目符号列表
  • `代码` 让一段文字显示为代码样式

写好之后,Markdown 文件可以被渲染成漂亮的格式化页面。

在你的项目里会怎么出现?

几乎每个 GitHub 项目的根目录都有一个 README.md——它用 Markdown 编写,GitHub 会自动把它渲染成项目首页的说明文档。

如果你的项目包含文档网站或博客,内容很可能也是用 Markdown(或它的增强版 MDX)编写的。MDX 在 Markdown 的基础上支持嵌入代码组件,让文档既能有丰富的文字排版,又能包含可交互的组件。

有什么需要注意的?

Markdown 语法极为简单,几分钟就能学会。需要注意的是:不同的平台(GitHub、博客工具、编辑器)对 Markdown 的扩展语法支持程度不同——比如表格、脚注、数学公式等高级功能不是所有地方都能用。核心语法(标题、列表、链接、代码块)是通用的。

也叫

MarkdownMD.md 文件MDX

和谁相连