3 分钟上手
先把 Markdown 用起来
这一页不讲术语大全,只告诉你 Markdown 适合哪里、文件怎么流转、先学什么以及别踩什么坑。
为什么现在还值得学 Markdown
今天的文档已经不只写给自己看。它会进入 Git 仓库、Issue、PR、知识库、静态站点,甚至会被 AI 工具读取、生成和继续加工。Markdown 仍然是这些环节里最通用、最容易迁移的一层文本格式。
- 协作平台原生支持:GitHub、GitLab、Notion、Obsidian 和大量文档工具都直接吃 Markdown。
- 纯文本可版本化:它适合纳入 Git,做 diff、review、回滚都自然。
- 便于 AI 二次整理:很多 AI 输出天然就是 Markdown,后续清洗和发布都方便。
你最可能在哪些地方用到它
- README:项目背景、安装方式、运行命令、目录结构和贡献指南。
- 协作讨论:Issue、PR 描述、会议纪要、需求拆分和排障记录。
- 知识库:个人笔记、团队 SOP、学习清单和设计草稿。
- 发布内容:博客、静态文档站、课程说明页和对外知识分享。
一个 Markdown 文件如何流转
- 你先在本地写一份
.md文件,把标题、列表、链接、代码结构整理好。 - 文件进入 Git 仓库,开始被团队 review、修改、同步和复用。
- 平台或构建工具把 Markdown 渲染成 HTML、PDF 或应用内页面。
- 最终内容出现在 GitHub、知识库、博客、文档站,或者继续作为资料沉淀下去。
Markdown 不是目的。它的价值在于让内容更容易协作、迁移、搜索和发布。
新手最容易踩的坑
- 一上来就学完所有语法:高频能力只有几项,先学会最常用的再说。
- 只记语法,不管结构:没有标题层级和信息分段,再多语法也救不了可读性。
- 过早依赖花哨编辑器:先能用纯文本写清楚,再决定工具链。
- 忽视平台差异:GitHub、Obsidian、静态站点支持的扩展语法并不完全一样。
3 步开始练习
- 随手找一个项目,先写一版 README,把项目做什么、怎么启动、常见命令写清楚。
- 只使用标题、列表、链接、代码块和强调这几项最常见语法。
- 把内容发到 GitHub 或本地文档站里看一遍,体会“写作”和“发布”之间的连接。
下一步学什么
如果你已经理解 Markdown 的角色,就不要继续停留在概念层。下一步应该直接进入高频场景。
评论
评论区暂未开放。
需要先为这个仓库启用 GitHub Discussions,并完成 giscus 配置后,评论功能才可用。