乐于分享
好东西不私藏

15 - Markdown 模版与自动化

15 - Markdown 模版与自动化

前言

这是本教程的最后一课。你学会了语法、编辑器、转换工具、知识管理。现在我们来聊聊「终极形态」——如何让重复的文档工作自动化。当你有了模板,写周报就是三分钟的事。当你有了脚本,格式转换就是双击的事。本课学完,你的 Markdown 工作流就彻底毕业了。

场景引入

小王现在已经是团队里的 Markdown 专家了。他用 Typora 写文档、用 Pandoc 转格式、用 Obsidian 管理知识库——效率比几个月前提升了不止一个级别。

但他发现一个新的瓶颈:每次写周报还是从零开始。

虽然他知道怎么写、怎么排、怎么转,但每周五下午还是要花 15-20 分钟来搭建周报的结构。模板思路他也有——复制上一周的文档清空内容。但他真正想要的是一份「本周常用的周报框架」,一打开就能直接填内容。

「让你的工作流再进化一步。」老张说,「用模板。以后每周五你打开一个文件,一切已经为你准备好了。」

模板和自动化是 Markdown 进阶的最后一块拼图。它们不改变你写内容的方式,但让「准备工作」变得几乎不需要时间。

文档模板

模板本质上就是一个「预留了空位的标准框架」。你把文档的结构、固定的表格、常用的段落提前写好,每次只需要填入变化的内容。

通用模板结构

一份好的模板应该包含:

  1. 固定的结构(标题层级、模块划分)
  2. 预留的填空位
  3. 需要手填的内容(用 [] 标记)

周报模板

创建一个 template-周报.md 文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# 项目周报([日期])> 本周核心:[一句话总结]---## 本周重点工作### ✅ 已完成- [ ] [任务 1]- [ ] [任务 2]### 🔄 进行中| 任务 | 负责人 | 完成度 | 预计完成 ||:-----|:------:|:------:|:--------:|| [任务] | [负责人] | [%] | [日期] |## 下周计划1. [计划 1]2. [计划 2]3. [计划 3]## 风险与支持> ⚠️ [风险描述]---*报完,周末愉快。*

每周五下午,复制这个模板,把 [ ] 中的占位符替换成实际内容——3 分钟就能完成一份周报框架。

会议纪要模板

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# 会议纪要:[会议名称]## 基本信息时间:[日期] [时间]地点:[地点/线上链接]主持人:[姓名]参会人:[姓名 1]、[姓名 2]记录人:[姓名]## 议程1. [议题 1]2. [议题 2]3. [议题 3]## 讨论内容### [议题 1]- [讨论要点 1]- [讨论要点 2]- **结论**:[最终决定]### [议题 2]- [讨论要点 1]- **结论**:[最终决定]## 待办事项| 事项 | 负责人 | 截止日期 ||:----|:------|:--------:|| [事项 1] | [姓名] | [日期] || [事项 2] | [姓名] | [日期] |

用模板的好处:你不会遗漏任何必要的模块。模板帮你预设了一个「完整文档应该有的结构」,你只要填空就好。

实战:从模板到成品

理论说完了,来看一个真实案例——一份周报从「空模板」变成「可交付的文档」的完整过程。

模板版本

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# 项目周报([日期])> 本周核心:[一句话总结]---## 本周重点工作### ✅ 已完成- [ ] [任务 1]- [ ] [任务 2]### 🔄 进行中| 任务 | 负责人 | 完成度 | 预计完成 ||:-----|:------:|:------:|:--------:|| [任务] | [负责人] | [%] | [日期] |## 下周计划1. [计划 1]2. [计划 2]3. [计划 3]## 风险与支持> ⚠️ [风险描述]---*报完,周末愉快。*

填完的成品

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# 项目周报(2026-07-22)> 本周核心:完成用户模块 API 开发,修复 3 个生产环境 Bug---## 本周重点工作### ✅ 已完成- [x] 用户注册/登录 API 开发(自测通过,覆盖率 92%)- [x] 修复线上订单状态不同步的 Bug(根因:缓存未及时失效)- [x] 数据库索引优化,慢查询从 2.3s 降至 80ms### 🔄 进行中| 任务 | 负责人 | 完成度 | 预计完成 ||:-----|:------:|:------:|:--------:|| 权限管理模块 | 张三 | 70% | 07-28 || 接口文档更新 | 李四 | 40% | 07-29 |## 下周计划1. 完成权限管理模块开发并提测2. 联调前后端接口3. 编写部署文档## 风险与支持> ⚠️ 第三方支付接口预计 07-30 才提供测试账号,可能影响联调进度---*报完,周末愉快。*

对应关系

模板占位符
成品内容
[日期]2026-07-22
[一句话总结]完成用户模块 API 开发,修复 3 个生产环境 Bug
[任务 1]
 → [任务 2]
用户注册/登录 API 开发
 → 修复线上...Bug
[任务]
 / [负责人] / [%] / [日期]
权限管理模块
 / 张三 / 70% / 07-28
[计划 1]
 → [计划 2] → [计划 3]
完成权限管理模块
 → 联调接口 → 编写部署文档
[风险描述]第三方支付接口...

看到对比了吗?模板帮你框好了结构,你只需要填入内容。这就是模板的核心价值——不是替你写,而是让你写的每句话都有它的位置。

之后再写周报时,你的流程就变成了:

  1. 复制模板文件
  2. 按 [ ] 标记逐项填充
  3. 把没完成的任务从「进行中」移到「已完成」
  4. 5 分钟后提交

这就是自动化之前的最后一步——让重复的结构性工作逼近零耗时

自定义模板的更高级方式

如果你愿意再多花一点时间配置,还可以让模板自动填入日期等动态信息。

在 Typora 中使用模板

Typora 支持自定义代码片段(Snippets)。你可以把常用段落保存为快捷键,比如:

  • 输入 /zbr 自动展开为完整的周报框架
  • 输入 /hyj 自动展开为会议纪框架

配置方法:「偏好设置」→「代码片段」→ 添加新的代码片段。

自动化脚本实战:批量添加 Front Matter

批处理最实用的场景之一:给多个 Markdown 文件批量添加统一的 YAML 头部(Front Matter)。

假如你有一堆笔记文件,想统一加上作者、日期、标签字段——一个个手动打开编辑太慢了。一个脚本就能搞定。

效果预览

处理前的一个文件:

1
2
3
4
# 用户注册流程设计## 需求概述...

处理后自动变成:

1
2
3
4
5
6
7
8
9
10
11
---title: 用户注册流程设计.mdauthor: your-namecreated: 2026-07-22tags: []---# 用户注册流程设计## 需求概述...

Windows 批处理脚本

创建一个 add-frontmatter.bat 文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
@echo offchcp 65001 >nulrem ===== 批量添加 Front Matter =====rem 给当前目录下所有 .md 文件添加 YAML 头部set AUTHOR=%USERNAME%for %%f in (*.md) do (    echo 处理:%%f    rem 用临时文件拼接 front matter + 原内容    (        echo ---        echo title: %%f        echo author: %AUTHOR%        echo created: %date%        echo tags: []        echo ---        echo.        type "%%f"    ) ^> "%%f.tmp"    rem 替换原文件    move /y "%%f.tmp" "%%f" ^>nul    echo 完成:%%f)echo.echo 全部处理完毕!pause

macOS/Linux 脚本

创建一个 add-frontmatter.sh 文件:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
#!/bin/bash# 批量添加 Front Matter# 给当前目录下所有 .md 文件添加 YAML 头部AUTHOR=$(whoami)DATE=$(date +"%Y-%m-%d")for file in *.md; do    echo "处理:$file"    # 用临时文件拼接 front matter + 原内容    {        echo "---"        echo "title: $file"        echo "author: $AUTHOR"        echo "created: $DATE"        echo "tags: []"        echo "---"        echo ""        cat "$file"    } > "${file}.tmp"    # 替换原文件    mv "file"    echo "完成:$file"doneecho ""echo "全部处理完毕!"

使用方式

  1. 把脚本文件放在需要处理的 Markdown 文件所在的目录
  2. Windows: 双击运行 add-frontmatter.bat
  3. macOS/Linux: 终端中执行 bash add-frontmatter.sh
  4. 所有 .md 文件会被自动加上统一的 Front Matter

⚠️ 脚本会直接修改文件。建议先在测试目录试运行,确认效果后再对重要文件执行。

你也可以修改脚本中的字段,加上自己需要的元数据(比如 status: draftcategory: 技术方案)。模板写死的是结构,脚本自动填入的是变量——两者结合起来,就是真正的文档自动化。

复用已有的模板

如果你已经写好了某一份质量不错的文档(比如一份完整的周报、一份拿到领导好评的方案),把它删掉具体数据、保留结构,就是一份很好的模板。你的最佳模板来自你自己写过的最好的文档。

文档即代码的理念

走到这一步,你可以开始理解文档即代码(Docs as Code)的理念了。

它的核心思想:用管理代码的方式来管理文档。

  • 纯文本存储(Markdown)
  • 版本管理(用文件名或版本号)
  • 模板化(预设结构)
  • 自动化(批处理)

你不需要成为程序员才能理解这个理念。实际上你已经在实践了——用 Markdown 写文档就是文档即代码的第一步:分开了内容和格式。

下一步可能是用 Git 管理文档版本(技术上不复杂,但这个超出本教程范围)。

实战:建立你的第一个模板库

建议你立刻做的事:

  1. 创建一个 templates/ 目录,放在 teach-markdown/ 下面
  2. 把你最常用的文档类型做成模板:周报、会议纪要、项目方案
  3. 每次写新文档前,先找到对应的模板
  4. 用了几次之后,根据实际使用体验优化模板结构

模板库是你的「工作加速器」。花 30 分钟建立模板,接下来每个季度节省的时间都是以天计的。

总结

模板 预设文档结构,占位符标记可变内容

周报模板 核心摘要 + 已完成/进行中 + 下周计划 + 风险

会议纪要模板 基本信息 + 议程 + 讨论 + 待办事项

Typora 代码片段 输入快捷键自动展开模板

批量添加 Front Matter 脚本 用 。bat / .sh 自动化处理多个文件

文档即代码 纯文本 + 模板 + 自动化的理念

全系列课程总结

恭喜你完成了全部 15 课的学习!

你的成长路径

1
2
3
4
5
6
7
8
L1(基本写作)     → L2(结构文档)标题、段落、列表    表格、链接、图片、代码块    ↓                    ↓L3(高效办公)     → L4(生态进阶)Typora + Pandoc      Front Matter + Mermaid + Obsidian    ↓                    ↓      实战:用 Markdown 完成办公文档全流程      终极:模板与自动化

你现在能做什么

  • ✅ 用 Markdown 写任何办公文档(周报、纪要、方案)
  • ✅ 熟练使用 Typora,知道快捷键和图片管理
  • ✅ 用 Pandoc 把 Markdown 转成 Word 和 PDF
  • ✅ 用 Front Matter 给文档加标签和元数据
  • ✅ 用 Mermaid 在文档中画流程图和甘特图
  • ✅ 用 Obsidian 管理个人知识库
  • ✅ 用模板自动化重复性文档工作

最后一句话

Markdown 不是一个需要「学习」的工具,而是一个需要「使用」的习惯。不要试图一下子掌握所有语法——从最简单的下一份会议纪要开始,写一份你就赚一份的时间。

现在关掉教程,去写你的第一份 Markdown 文档吧。