Markdown 实战指南

把 Markdown
写进真实工作流

这不是一份照本宣科的语法表，而是一条面向开发者、写作者和团队协作的 Markdown 使用路线。 你会把它真正用在 README、知识库、Issue、博客和项目文档里。

从 3 分钟上手开始 查看常用编辑器

Markdown 在哪里最值钱？

当内容需要协作、版本控制和发布时，Markdown 的优势才真正显现。

把 README 写清楚

安装步骤、运行命令、目录结构和常见问题都适合用 Markdown 交代明白。

沉淀团队知识

会议纪要、排障记录、设计草稿和 SOP 都能长期维护在一份易读的纯文本里。

在 GitHub 协作

Issue、PR、Discussion、Wiki 本身就是 Markdown 的高频战场，写得清楚就能少来回沟通。

发布成文档站

同一份 Markdown 内容还能继续喂给 Astro、VitePress 或 GitHub Pages 生成网站。

一条更像真实工作的学习路径

如果你的目标是把文档写清楚，而不是背一张语法表，建议按下面顺序学习。

1

先写一份别人看得懂的 README

先交代项目解决什么问题、怎么安装、怎么运行。让读者先活下来，再谈完整语法。

2

优先掌握高频基础语法

标题、列表、链接、代码块、强调和段落，已经能覆盖大多数 README、Issue 和知识库页面。

3

按平台补扩展语法

表格、任务列表、脚注和自动链接不是不用学，而是应当按真实需求补上。

4

最后再挑编辑器和发布工具

先建立稳定写作习惯，再决定 Obsidian、VS Code、Astro 还是 GitHub Pages 这套工具链。

先看高频语法 
# Markdown-Tutorial

## 本周目标
- 写清安装步骤
- 补上贡献说明
- 记录已知问题

## 发布路径
README -> Docs -> GitHub Pages

[在线预览](https://albert-lsk.github.io/Markdown-Tutorial/)

从任务出发选内容

不同页面对应不同阶段：先建立上下文，再掌握高频语法，最后补平台差异和工具链。

3 分钟上手

先搞清楚 Markdown 在真实工作里到底解决什么问题。

进入入门 →

高频基础语法

先学最常用的 6 项能力，而不是第一天背完整语法清单。

查看基础语法 →

扩展语法差异

当你真的需要表格、任务列表或脚注时，再补这部分最划算。

查看扩展语法 →

编辑器与工具链

最后再选择编辑器、预览方式和发布平台，避免工具先行。

选择编辑器 →

评论

评论区暂未开放。

需要先为这个仓库启用 GitHub Discussions，并完成 giscus 配置后，评论功能才可用。