送给 James —— 恭喜你创建了人生中第一个 GitHub 仓库!🎉
Markdown 是一种轻量级标记语言。一句话解释:用几个简单的符号(#、*、- 等)就能写出排版整洁的文档,全程双手不离键盘,不用像 Word 那样点来点去调格式。
你现在看的这份文档,就是用 Markdown 写的,它的文件后缀是 .md。GitHub 仓库首页那段介绍(README.md)也是它写的。
学一次,GitHub、知乎、语雀、飞书、Notion、Discord…… 到处都能用。
- 🪶 简单:十几个符号就够用
- ⚡ 高效:专注写内容,不折腾排版
- 🌍 通用:一次学会,处处适用
- 📦 GitHub 标配:好的
README是项目的门面
用 # 表示标题,# 越多标题越小(共 6 级),注意 # 和文字之间要空一格:
# 一级标题
## 二级标题
### 三级标题
**粗体** 用两个星号包起来
*斜体* 用一个星号包起来
~~删除线~~ 用两个波浪号
渲染出来就是:粗体、斜体、删除线。
无序列表用 -(减号后空一格):
- 苹果
- 香蕉
- 橙子
有序列表用「数字 + 点」:
1. 起床
2. 写代码
3. 睡觉
行首缩进两个空格就能嵌套:
- 水果
- 苹果
- 香蕉
链接:[显示的文字](网址)
[点我访问 GitHub](https://github.com)
图片:就是在链接前面加一个感叹号 !

💡 记忆法:图片 = 链接 + 前面加个
!
行内代码用一对反引号(就是键盘左上角、数字 1 左边那个 ` 键)包起来,比如提示别人运行 git status。
代码块则用三个反引号另起一行包裹,还能在开头写上语言名来实现语法高亮,效果长这样:
def greet(name):
print(f"你好, {name}!")
greet("James")用 > 开头表示引用,很适合写提示、备注、名言:
> 这是一段引用
> 好的代码本身就是最好的注释
用 | 分隔每一列,第二行用 --- 把表头和内容分开:
| 姓名 | 擅长语言 |
| ----- | ---------- |
| James | Python |
| 你 | JavaScript |
单独一行写三个或更多 -,就是一条横线(就像本文里那些分割线):
---
- [x] 创建人生第一个仓库
- [x] 学习 Markdown
- [ ] 写出第一个项目
在 GitHub 上,这会显示成可以打勾的复选框,用来做 TODO 特别方便!
打开仓库时,别人第一眼看到的就是 README.md。一个好的 README 通常包含:
- 项目名 + 一句话简介 —— 让人一眼看懂这是干嘛的
- ✨ 功能特性 —— 你的项目能做什么
- 📦 安装 / 使用方法 —— 配上代码块,别人照着就能跑起来
- 📸 截图或示例 —— 一图胜千言
- 📄 开源许可证(License) —— 告诉别人能怎么用你的代码
Markdown 的精髓就一句话:用最简单的符号,写最清晰的文档。
不用刻意背,写几次自然就记住了。现在就打开你的 README.md,动手敲敲看吧!
在代码的世界里玩得开心~ 🚀
Happy Coding, James! 💻