第 1 章:你的第一篇技术文档¶
场景: 你刚学完一门课程,想把笔记整理成一份结构清晰的文档,方便自己和同学复习。打开编辑器,让我们用 Markdown 来完成这个任务。
1.1 从一份课程笔记开始¶
假设你正在学习 Python,想记录以下内容:
- 课程标题
- 几个知识点的说明
- 一些重点标记
- 一段参考资料的引用
打开 VS Code(或任何文本编辑器),新建一个文件,命名为 python-notes.md,开始写:
# Python 入门笔记
## 变量与数据类型
Python 是一种**动态类型**语言,变量不需要声明类型。
### 基本数据类型
- 整数(int):`42`
- 浮点数(float):`3.14`
- 字符串(str):`"Hello"`
- 布尔值(bool):`True` / `False`
### 类型转换
使用 `int()`、`float()`、`str()` 等函数进行类型转换。
> **提示:** Python 的变量名区分大小写,`name` 和 `Name` 是两个不同的变量。
---
*整理于 2026 年 5 月*
渲染效果:
Python 入门笔记¶
变量与数据类型¶
Python 是一种**动态类型**语言,变量不需要声明类型。
基本数据类型¶
- 整数(int):
42- 浮点数(float):
3.14- 字符串(str):
"Hello"- 布尔值(bool):
True/False类型转换¶
使用
int()、float()、str()等函数进行类型转换。提示: Python 的变量名区分大小写,
name和Name是两个不同的变量。
整理于 2026 年 5 月¶
你已经不知不觉用到了 Markdown 最核心的几个语法!让我们逐一拆解。
1.2 标题:文档的骨架¶
# 号的数量决定标题级别(1~6 级):
# 一级标题 —— 通常用于文档标题,一个文档只用一次
## 二级标题 —— 用于大章节
### 三级标题 —— 用于小节
#### 四级标题
##### 五级标题
###### 六级标题 —— 比正文还小,很少使用
渲染效果:
一级标题¶
二级标题¶
三级标题¶
四级标题¶
五级标题¶
六级标题¶
标题规范
#后面要加一个空格再写文字- 一级标题通常一个文档只用一次
- 建议用二级和三级标题组织内容结构
1.3 段落与换行:控制呼吸感¶
渲染效果:
这是第一段。Markdown 中直接换行不会产生新段落,仍然属于同一段。
这是第二段。空一行才会产生新的段落。
这是第一行。
在行尾加两个空格再换行,
可以实现段内换行(不产生段落间距)。
1.4 文字格式:突出重点¶
**这是粗体文字** —— 用于强调关键词
*这是斜体文字* —— 用于术语、书名
***这是粗斜体文字*** —— 双重强调
~~这是删除线文字~~ —— 表示已废弃的内容
`这是行内代码` —— 用于变量名、函数名
渲染效果:
这是粗体文字 —— 用于强调关键词
这是斜体文字 —— 用于术语、书名
这是粗斜体文字 —— 双重强调
这是删除线文字—— 表示已废弃的内容
这是行内代码—— 用于变量名、函数名
1.5 引用:突出重要信息¶
渲染效果:
这是一段引用文字。引用可以有多行。
空一行后继续引用。
嵌套引用:
这是第二层引用。
这是第三层引用。
1.6 分隔线:划分内容区块¶
渲染效果: 三个或更多的 -、*、_ 会渲染为一条横跨页面的水平分隔线:
1.7 了解 Markdown 的"为什么"¶
在继续之前,理解 Markdown 的设计哲学能帮你更好地使用它:
标记语言 vs 所见即所得
- 标记语言(Markdown):用特殊符号标记格式,如
**粗体**。优点是纯文本、版本控制友好、不依赖特定软件。 - 所见即所得(Word):直接看到最终效果。优点是直观,但文件格式封闭、不易版本管理。
Markdown 的核心设计原则只有两条:
- 易读性优先:即使不渲染,纯文本形式的 Markdown 也应该清晰可读。
- 可转换为 HTML:Markdown 是 HTML 的简化写法,任何 Markdown 都能转为标准 HTML。
# 这是 Markdown 写法
## 二级标题
**粗体文字**
<!-- 等价于以下 HTML -->
<h1>这是 Markdown 写法</h1>
<h2>二级标题</h2>
<strong>粗体文字</strong>
渲染效果: Markdown 源码本身就像一份结构清晰的纯文本大纲,即使不经过渲染也能轻松阅读。渲染后则变成带有层级标题和格式的网页。
1.8 选择你的写作工具¶
| 编辑器 | 平台 | 特点 |
|---|---|---|
| VS Code | 全平台 | 免费、插件丰富、实时预览 |
| Typora | 全平台 | 所见即所得、导出功能强大 |
| Obsidian | 全平台 | 笔记管理、双向链接、知识图谱 |
| Notion | 全平台 | 在线协作、数据库功能 |
| GitHub 网页端 | 浏览器 | 在线编辑、直接预览 |
推荐选择
如果你已经安装了 VS Code,直接在 VS Code 中写 Markdown 是最方便的选择。安装 Markdown Preview Enhanced 插件即可实时预览。
Markdown 文件使用 .md 或 .markdown 扩展名,推荐使用 .md。
本章回顾¶
你已经完成了第一份 Markdown 文档!回顾一下你掌握的技能:
- 用
#创建层级标题 - 用空行分隔段落,用两个空格实现段内换行
- 用
**粗体**、*斜体*、~~删除线~~格式化文字 - 用
>创建引用块 - 用
---画分隔线 - 理解了 Markdown 的设计哲学