Markdown 是什么
Markdown 是什么?为什么写文档和 README 经常见到它
Markdown 的吸引力不在于“功能比 Word 多”,恰恰相反,它用很少的符号表达标题、列表、链接、代码块等常见结构。
它本质上还是纯文本
你可以直接用普通文本编辑器打开 Markdown 文件。渲染之后,`# 标题`、`- 列表` 这类语法会变成更易读的版式。
为什么开发者特别常用
纯文本容易做版本控制,也适合放进代码仓库,所以 README、技术文档和静态站内容里很常见。
简单语法带来的好处是迁移容易
Markdown 文件本身就是文本,即使以后不用原来的编辑器,内容通常仍能打开和转换。这也是它适合长期文档、笔记和静态网站的原因之一。
不过不同平台会扩展表格、任务列表、脚注等语法,跨平台迁移前最好确认这些扩展是否兼容,不要把所有 Markdown 都当成完全相同。
一个最小示例
在 README.md 中使用 # 项目名称 写标题,用 - 表示清单,用 [说明](https://example.com) 表示链接。Markdown 是纯文本标记语法,具体显示效果由渲染器决定;不同平台在表格、任务清单和代码块等扩展语法上可能不完全一致。
写完文档怎样交付
把 README.md 同图片等附件一起保存,检查相对图片路径是否有效,并在目标平台预览一次。若需要交给不使用 Markdown 的同事,可另行导出 PDF 或其他格式,但保留源文件便于后续修改。