供绝对初学者使用的 Markdown Cheat Sheet(将此加入书签)
您刚刚发现了 Markdown,大家都说它 "简单",但您却盯着星号、哈希值和括号不知从何下手。你的同事不经意间提到他们用 Markdown 写了所有东西。你最喜欢的教程博客就是用它写的。GitHub 的 READMEs 随处可见。但是,当你尝试学习它时,文档却让你不知所措。
事实是:Markdown 真的很简单--但前提是必须有人向你展示它的精髓。
这份小抄将成为你收藏最多的资源。我将准确地向你展示你需要知道的东西:可视化示例、并排比较,以及你可以永久保存的可下载参考资料。没有华丽的辞藻,没有复杂的边缘案例,只有实用的语法,每天都能为你服务。
让我们在接下来的 8 分钟内,让你成为一名自信的 Markdown 用户。
📝Markdown Cheat Sheet for Absolute Beginners (Bookmark This!)
什么是 Markdown?
Markdown 是一种可转换为 HTML 的纯文本格式。就是这样。你在书写时使用简单的符号,如**粗体**,它就会以粗体显示。没有按钮,没有工具栏,没有专有软件。
以下是初学者爱上它的原因:
它无处不在:GitHub 将其用于 README 文件。Reddit 用它来处理评论。Discord、Notion、Stack Overflow、Jupyter Notebooks 和无数博客都支持 Markdown。一次学习,随处写作。
面向未来:Markdown 文件是纯文本。它们可以在任何设备、任何操作系统上打开,50 年后也是如此。试试打开 1995 年的 Microsoft Word 文件--祝你好运。您的 Markdown 文件呢?它们永远有效。
便于携带:从 Notion 复制文本,粘贴到 GitHub,再移动到你的博客。Markdown 移动起来不会中断。没有 "格式丢失 "的噩梦。
你已掌握基础知识有没有在聊天文本周围打上星号,以强调某些内容?这就是 Markdown 思维。你比自己意识到的还要接近。
速成只需学习七条语法规则,你就能满足 90% 的格式化需求。七条。这比记住微软 Word 的快捷键还简单。
准备好了吗?让我们深入了解这七条规则。
你每天都会用到的七条 Markdown 语法规则
掌握这七条格式规则,你就能满足 90% 的写作需求。每条规则只需 30 秒即可学会。我将向你展示语法、呈现后的效果以及使用时机。
1.粗体和斜体文本
语法:
**bold text**
*italic text*
***bold and italic***
渲染为
- 粗体文本
- 斜体文本
- 粗体和斜体
何时使用粗体可引起对重要内容的注意。斜体则是微妙的强调。将粗体视为大声喊叫,将斜体视为俯身低语。
专业提示:粗体用
**双星号**,斜体用*单星号*。有些人使用下划线(__粗体__或_斜体_),但星号更常见,在任何地方都适用。
常见错误:将空格放在星号内会破坏格式。** 文本 **将不起作用。保持紧凑:**文本**。
2.标题(创建结构)
语法:
# Heading 1 (Title)
## Heading 2 (Section)
### Heading 3 (Subsection)
#### Heading 4 (Sub-subsection)
经验法则:文件标题用一个#,主要部分用##,这些部分中的小节用# ##。大多数文件不需要超过三个标题级别。
结构示例:
# My Project Documentation
## Getting Started
### Installation
### Configuration
## Advanced Usage
### API Reference
### Troubleshooting
⚠️常见错误:不要跳级。从
##直接跳到####会让读者感到困惑,也会破坏导航功能。一定要按顺序排列。
为什么重要?标题是文档的骨架。它们可以帮助读者进行扫描,跳到需要的部分,并一目了然地了解您的结构。
3.列表(项目符号和数字)
语法:
- Bullet point
- Another point
- Third point
1. First item
2. Second item
3. Third item
对于嵌套列表,缩进 2 个空格:
- Main point
- Nested point
- Another nested point
- Back to main level
1. First step
- Detail about first step
- Another detail
2. Second step
渲染为
-
要点
- 嵌套点
- 另一个嵌套点
-
返回主层
💡快速窍门:您可以使用
-、*或+来表示项目符号点,它们都可以。为了保持一致,请坚持使用"-"(这是最常用的惯例)。
另一个技巧:对于编号列表,您只需对每个项目使用1.,Markdown 就会自动编号。这样重新排序就更容易了:
1. First item
1. Second item
1. Third item
仍然渲染为 1、2、3。
4.链接
语法:
[Link text](URL)
真实示例:
[Google](<https://google.com>)
[My GitHub Profile](<https://github.com/leonwong282>)
[Email me](leonwong282@gmail.com)
最佳实践:使用描述性链接文本,告诉读者链接的目的地。不要这样做:
❌点击 [此处](url)查看文档
请这样做:
✅阅读 [Python 文档](网址) 了解详情
为什么?这对可访问性(屏幕阅读器)更好,对 SEO 更好,对扫描您内容的读者更有帮助。
💡电子邮件链接:在 URL 中使用
mailto:创建可点击的电子邮件链接:[联系我](leonwong282@gmail.com)5.
5.图片
语法:

真实例子:

关键区别:开头的感叹号使其成为图片。如果没有感叹号,就只是一个普通的链接。
= 显示图片- [
text](url)= 创建一个可点击的链接
Alt 文本很重要:[ ]内的文本是你的alt文本。如果图片加载失败,它就会显示出来,帮助使用屏幕阅读器的视障读者。一定要编写描述性的alt文本。
好:![显示 npm install 命令的终端截图]
坏:![image1]或![pic]。
6.代码(内联和块)
这是 Markdown 在技术写作中真正的闪光点。
内联代码(用于简短的代码片段):
Use the `print()` function to display output.
The variable `user_id` stores the ID.
Run `npm install` to install dependencies.
渲染为使用print()函数显示输出。
代码块(用于多行代码):
```python
def hello_world():
print("Hello, World!")
**显示为**
```python
def hello_world():
print("Hello, World!")
💡语言高亮显示:在语法高亮显示的开头三个回车键后添加语言名称。常用选项:
python、javascript、java、sql、bash、html、css、json
以 JavaScript 为例:
const greeting = (name) => {
console.log(`Hello, ${name}!`);
};
语言标识符可提供漂亮的彩色编码语法高亮显示。
7.方括号
语法:
> This is a quote or callout.
> It can span multiple lines.
渲染为:
这是一个引号或注释。
它可以跨越多行。
使用方括号的目的是
- 实际引用来源
- 重要提示或警告
- 突出关键要点
- 需要强调的注释或提示
嵌套引语:
> Outer quote
>> Nested quote
>>> Deeply nested
大多数人很少嵌套引文,但如果你需要,它还是存在的。
每个初学者都会犯的 5 个错误(立即改正)
我教过成百上千的人学习 Markdown。这五个错误每次都会出现。现在就学习它们,为自己省去几个小时的挫败感。
错误 1:忘记空白行
问题:如果不在段落和章节之间添加空行,它们就会连在一起。
例如
错:
## Heading
Text starts immediately here.
More text on the next line.
✅对:
## Heading
Text starts after a blank line.
New paragraph after another blank line.
为什么会这样?在纯文本中,按一次回车键只是继续该段落。Markdown 需要空行来显示你想要一个新的段落或章节。
解决方法一定要在标题前后、段落之间、列表周围、代码块和引号中添加空行。
错误 2:粗体/斜体语法中的空格
问题:在星号内空格会破坏格式。
❌错误:** 文本 **或* 文本 *
✅正确:**文本**或*文本*
会发生什么?Markdown 会看到空格,并认为您没有尝试格式化--它会按字面意思显示星号: 文本
解决方法让格式标记紧贴文本。星号和要格式化的文本之间不能有空格。
Mistake #3: Forgetting the!for Images
问题:写[Image](url)会创建一个指向图片的链接,而不是嵌入式图片。
链接(不是你想要的):[Logo](logo.png)→徽标
✅图像(嵌入):徽标](logo.png)→ 显示实际图像
为什么会出现这种情况?链接和图片的语法几乎完全相同。一个小小的!就决定了一切。
记忆窍门:感叹号就是你在感叹:"快看这幅图!"
错误 4:列表缩进不一致
问题:由于缩进不当,嵌套列表会断开或看起来不对。
❌错误(只有 1 个空格):
- Main item
- Nested (might not render correctly)
正确(2 个空格或 1 个制表符):
- Main item
- Nested (clean indent)
- Another nested
- Back to main
解决方法:嵌套项一定要缩进2个空格(或 4 个空格,或 1 个制表符--请保持一致)。一个空格太少,会破坏许多平台上的渲染效果。
错误 5:不跨平台测试
问题:您的 Markdown 在编辑器中看起来很完美,但在 GitHub 或 Medium 上却会出现问题。
为什么会这样?不同的平台使用不同的 Markdown "口味"--支持的内容略有不同。
解决方法
- 在发布前预览您的 Markdown(大多数编辑器都有预览模式)
- 在目标平台上进行测试(在暂存中编写,上线前预览)
- 如果有疑问,请坚持使用必备的 7 种工具--它们在任何地方都适用
编写 Markdown 的必备工具
这些免费工具会让你的 Markdown 工作流程轻松 10 倍。我每天都在使用这些工具,它们将为你节省时间,减少挫折。
最佳 Markdown 编辑器
Typora(Mac/Windows/Linux)
- 它的特别之处所见即所得编辑器--输入时即可看到格式化文本
- 免费/付费:可试用,一次性购买
VS Code(所有平台)
- 特点免费、功能强大、内置预览(Ctrl+Shift+V)
- 免费/付费:完全免费
Dillinger(在线)
- 它的特点无需安装,可在任何浏览器中使用
- 免费/付费:免费
Notion(所有平台 + 网络)
- 它的特别之处将 Markdown 快捷方式与丰富功能相结合
- 免费/付费:提供免费计划
自己试试5 分钟挑战
准备好测试您的新技能了吗?完成这项挑战,你就会知道自己已经掌握了基础知识。
挑战
-
打开编辑器:访问Dillinger.io(无需注册)
-
创建一个文档:
- ✅ 一个 H1 标题(你的文档标题)
- ✅ 两个 H2 标题(两个主要部分)
- ✅ 至少一个句子中的粗体文字
- ✅ 至少一句话中的斜体文字
- ✅ 包含 3 个项目的列表
- ✅ 一个外部链接(指向任何网站)
- ✅ 一个内嵌代码示例
- 一个带语言高亮的代码块
挑战解决方案示例
情况可能是这样的:
# My First Markdown Document
## Introduction
This is my **first** attempt at Markdown and I'm *already* getting the hang of it!
Here's what I've learned:
- Markdown is simple
- It works everywhere
- I can use it for `code` examples
## Code Example
Here's a Python function:
```python
def greet(name):
return f"Hello, {name}!"
Check out the Markdown Guide for more!
**设置一个 5 分钟的计时器,现在就试试。**如果你能在不回看语法的情况下创建此文档,那么你就掌握了基础知识。说真的,把这篇文章放在一边,测试一下自己。
---
## 你将创建什么?
Markdown 的魅力在于它的简单性。没有复杂的软件。无需授权没有令人头疼的格式问题。只有你、纯文本,以及随时随地在任何设备上写作的能力。
**现在,你就是 Markdown 社区的一员--数以百万计**的开发者、写作者和创作者,他们选择了简洁性和可移植性,而不是专有工具。
**请在下面发表评论**:你用 Markdown 写的第一件事是什么?README?注释?文档?我阅读每一条评论,喜欢看到大家的创作!
**觉得这对你有帮助吗?**请与正在学习 Markdown 的人分享。收藏它,以备将来参考。需要快速语法提醒时,随时回来看看。
**写作愉快**🚀
---
*想了解更多适合初学者的教程?关注 GitHub、Web 开发和生产力工具指南,让你的生活更轻松。*
相关内容:
- [Image Hosting for Markdown: The Complete Guide to Picture Beds](<https://www.notion.so/Image-Hosting-for-Markdown-The-Complete-Guide-to-Picture-Beds-1dd4acfb1cac8039b240e72e8795165a?pvs=21>)