1 / 23
翻页
← 左右滑动翻页 →

把你的经验
变成在线手册

Markdown + HTML + SVG + GitHub
一个下午搞定,AI帮你干活

← 滑动开始 →

这本教程在做什么

你正在看的这个页面--翻页式、有配图、手机上也能看--就是用这套方法做出来的。

没有设计师参与,没有手写一行代码,没有花钱买服务器。

它本身就是效果证明。

接下来我要分享的,就是做出它的全套方法。如果你有一些经验想整理成手册、教程、指南--不管是给团队用的SOP还是给客户看的入门说明--这套组合拳可能对你有帮助。

想象你是个厨子。你做了十年菜,肚子里全是经验。但经验存在脑子里,别人看不到也用不了。这套方法就是帮你把那些"肚子里的菜谱"整理成一本像样的、别人翻开就能照着做的食谱。

前提:你已经在用某种 AI agent 工具(WorkBuddy、ColaOS、Codex、Trae等皆可),并且网络环境顺畅。

上一页 下一页

左右滑动翻页

四把钥匙

整件事情只用四样东西。每一样我都会讲为什么需要它--不只是"怎么用"。

Markdown HTML + SVG GitHub Skill 组织内容 呈现内容 发布内容 提升质量

它们是一条自然的递进链--每一环解决前一环留下的问题。别急,我们一个一个来。

为什么是 Markdown

你和 AI 对话的时候,是不是经常这样:

"帮我写一个关于XX的教程,要包含入门、进阶、常见问题......"
AI 哗啦啦回了2000字。你看了一眼,觉得"挺好的"--但哪里好?结构对不对?漏没漏东西?说不清。

问题出在哪?纯文字是一坨面糊。你很难一眼看出它的骨架。

Markdown 就像菜单的草稿纸。当你在纸上写"凉菜""热菜""汤品"的时候,你不是在写菜谱--你是在审视结构。三个大类对不对?顺序合不合理?有没有漏掉甜品?

所以 Markdown 的核心价值不只是"给 AI 看的输入格式",更是你审视 AI 输出的工具

当 AI 回复你的时候,如果它用 Markdown 格式--有 # 标题、有 - 列表、有层级--你一扫就知道:结构对不对、深度够不够、有没有跑题。

Markdown:审视的工具

来看一个对比。同样一段内容,两种写法:

❌ 纯文字版

客户入职流程分为三个阶段,首先需要签订合同,签完后进入账号创建阶段,我们会在一个工作日内完成,然后进入培训阶段,通常安排在第一周内,培训内容包括系统操作和常见问题处理......

✓ Markdown 源码

# 客户入职流程 ## 1. 签约阶段 - 签订合同 - 确认付款 ## 2. 账号创建(1个工作日) - 创建系统账号 - 发送欢迎邮件 ## 3. 培训(第一周内) - 系统操作培训 - 常见问题处理

✓ 渲染后的效果

客户入职流程

1. 签约阶段

  • 签订合同
  • 确认付款

2. 账号创建(1个工作日)

  • 创建系统账号
  • 发送欢迎邮件

3. 培训(第一周内)

  • 系统操作培训
  • 常见问题处理

同样的信息,源码让你一眼审视结构,渲染后让读者舒服阅读。两种视角,两种价值。

这就是"审视"--Markdown 让结构显性化。

动手:第一份 Markdown

打开你的 AI agent,把下面的提示词复制给它:

PROMPT 请帮我用 Markdown 格式,列出"[你的主题]"的基本框架。 要求: - 用 # 和 ## 表示层级 - 每个章节下用 - 列出3-5个要点 - 不需要写具体内容,只要框架 先输出框架让我确认结构,确认后再展开写。

[你的主题] 换成你自己的内容。比如"新人入职指南""客户常见问题""我的摄影后期流程"--任何你想整理的东西。

AI 会回复一个带有 # 标题和 - 列表的框架。你应该能一眼看出整体结构--哪里多了、哪里少了。如果结构不对,直接说"把第三部分拆成两个""加一个FAQ章节"。

关键心法:先审结构,再填内容。不要让AI一次性全写完--你会丧失审视的主动权。

Markdown 进阶结构

当框架确认后,让 AI 逐章展开。每章可以用这些 Markdown 元素:

  • ## 标题 - 章节名
  • ### 小标题 - 子章节
  • - 列表项 - 要点罗列
  • **粗体** - 强调关键词
  • > 引用 - 补充说明或注意事项
PROMPT 现在请展开第一章的内容。要求: - 保持 Markdown 格式 - 每个要点用1-2句话解释 - 如果有操作步骤,用有序列表(1. 2. 3.) - 有专业术语的地方加一句通俗解释
AI 回复会保持层级结构。你可以逐章审视--每次只确认一章,确认完再让它写下一章。这样你始终掌控全局。

三章写完,你大概率会有一个感受--翻下一页我来说。

递进:纯文字不够了

三章 Markdown 写完,你把它读一遍。然后你会发现--

纯文字读起来累。

内容没问题。结构也对。但满屏都是字,你自己都不想看第二遍。如果你都不想看,凭什么期待别人看?

内容一样,呈现方式决定了别人愿不愿意接收。想想你平时看的公众号文章--同样的内容,有配图、有缩进、有高亮的那篇,你是不是更愿意读下去?

就像做菜--食材一样,但一份装在保温饭盒里,一份摆了盘还撒了芝麻。味道一样,但后者让人"愿意动筷"。HTML 和 SVG 干的就是这个事:不改内容,改"摆盘"。

接下来两层:

  • HTML - 让内容有排版、有样式、有颜色,从"笔记"变成"页面"
  • SVG - 让你拥有定制图形,不用找素材、不担心版权、放大不糊

你不需要学会它们--你只需要知道它们干什么,然后让 AI 帮你写。

HTML:给内容穿衣服

HTML 不是编程语言--它是"标记语言"。什么意思?就是你在内容旁边做标记:这里是标题、那里是段落、这块要加粗。

# 我的标题 一段内容... - 列表项 Markdown AI 转换 我的标题 一段漂亮的内容 • 精美列表项 HTML 页面

好消息是:你不需要学 HTML。AI 会帮你写。你只需要:

  • 把你的 Markdown 内容给 AI
  • 告诉它你想要什么风格("简洁的""科技感的""温暖的")
  • 它就给你一个完整的 HTML 文件

你做的是"选菜"和"验收",AI 是"厨师"。

动手:第一个 HTML 页面

把你之前写好的 Markdown 内容(哪怕只是第一章)交给 AI:

PROMPT 请把下面的 Markdown 内容转成一个漂亮的 HTML 页面。 要求: - 单文件,所有样式内嵌 - 风格简洁现代,适合手机阅读 - 用好看的字体和间距 - 加适当的颜色(不要太花哨) 内容如下: [粘贴你的 Markdown 内容]
AI 会输出一个 .html 文件。用浏览器直接打开它--你会看到一个有样式的页面。跟刚才的纯文字 Markdown 对比一下视觉差异。

看到效果了?内容没变一个字,但观感完全不同。这就是"摆盘"的力量。

如果觉得字体不对、颜色不喜欢--直接告诉 AI "标题换成红色""段落间距再大一点"。它会帮你改。

SVG:你的免费画笔

页面有了,但全是文字的页面还是单调。你需要图。

传统做法:去图片网站找素材→担心版权→下载→调整大小→放进去。麻烦。

SVG 的做法:让 AI 画。

SVG 是"用代码描述的图形"。意思是--你告诉 AI "画一个表示流程的示意图",它直接写出来,不需要 Photoshop,不存在版权问题,而且放大缩小都不模糊。

想法 AI 画 成品

你不需要会画画,也不需要学 SVG 语法。你只需要描述你想要什么图,AI 来实现。

动手:画一个 SVG 图标

PROMPT 请用 SVG 画一个简单的流程图,展示以下步骤: 1. 写内容(红色方块) 2. 做页面(蓝色方块) 3. 发布上线(黄色方块) 要求: - 三个方块横排,中间用箭头连接 - 方块下面写步骤名称 - 风格简洁,蒙德里安风 - 输出纯 SVG 代码
AI 回复一段 SVG 代码。你可以把它直接贴到 HTML 文件里(放在你想要图片出现的位置),浏览器刷新就能看到图形。

试试改描述——“把三个方块改成圆形”“加一个第四步”——AI 会即时修改。你会发现:调整一张图比写一段话还快。

SVG 的常见用途

  • 流程图——展示步骤顺序
  • 对比图——前后差异、方案对比
  • 图标——为你的页面加视觉符号
  • 数据可视化——简单的图表、比例图

没有素材可找?让 AI 画。没有版权能用?让 AI 画。这就是 SVG 的自由。且它永远不会糊——放大多少倍都清晰。

GitHub:为什么需要它

现在你有了 HTML 文件,在自己电脑上打开没问题。但它只存在于你的硬盘里--别人看不到,而且万一文件丢了就没了。

GitHub 是什么?简单说:一个免费的「文件存放+展示」平台。全球最大的开源社区,所有人都把自己的作品放在这里。

它对你有三个实际用处:

1 发布:让别人看到

GitHub 免费把你的 HTML 变成一个真实网址。发链接给任何人就能看。不用买服务器,不用懂运维。

2 参考:公共弹药库

GitHub 上有无数人做好的模板、组件、工具。看到喜欢的页面?复制链接给 AI 说"照这个风格来"--不用重复造轮子。

3 记录:版本管理 + 作品日历

每次修改都被记录。想回到上一版?随时可以。而且还有一个"绿点日历"让你看到自己的产出轨迹。

类比:你的 HTML 是一家店的装修,GitHub 提供了三样东西--一个店铺地址(别人能来)、一个建材市场(你能拿别人的材料)、一本自动记录的装修日志(每次改动都有据可查)。

GitHub:注册与建仓

github.com 注册一个账号。邮箱验证完就行,免费的。

确保网络环境顺畅。

注册好之后,让 AI 帮你建第一个"仓库"(Repository):

PROMPT 我已经注册好了 GitHub 账号,用户名是 [你的用户名]。 请一步步指导我创建第一个仓库(Repository),要求: - 仓库名叫 my-manual(或你喜欢的名字) - 设为 Public(公开) - 勾选 "Add a README file" 请告诉我在哪里点、点什么,每一步都配截图描述。
你应该看到一个新建的仓库页面,里面有一个 README.md 文件。仓库地址类似:github.com/你的用户名/my-manual
"仓库"这个词听着技术,其实就是一个"文件夹"--一个在网上的文件夹。你的手册的所有文件都放这里。

GitHub:上传与发布

仓库建好了,现在把你的 HTML 文件放进去,然后开启"展示橱窗"。

PROMPT 我已经创建了仓库 my-manual。现在请指导我: 1. 把我的 index.html 文件上传到这个仓库 2. 开启 GitHub Pages,让别人通过网址能访问到我的页面 请一步步说明操作路径(在哪里点击什么按钮)。
  1. 在仓库页面点 "Add file" → "Upload files"
  2. 拖入你的 HTML 文件(和 CSS/JS 如果有的话)
  3. 点 "Commit changes"
  4. 进入 Settings → Pages → Source 选 "main" 分支 → Save
  5. 等待1-2分钟,你会获得一个类似 https://你的用户名.github.io/my-manual/ 的网址
打开那个网址,你的手册已经在线了。发给任何人都能看。手机也能看。全球都能访问。免费的。

GitHub:弹药库

这是 GitHub 最被低估的用法--不只是放自己的东西,更是拿别人做好的东西

场景1:你想做一个翻页式教程

搜 GitHub,找到一个你喜欢的模板。把链接给 AI:"照这个风格帮我改成我的内容。"

场景2:你需要一个好看的代码高亮样式

搜 GitHub,找到别人调好的配色方案。直接拿来用。

场景3:你想加个目录导航

找到别人做好的导航组件,复制代码给 AI 说"把这个加到我的页面里"。

GitHub 就像一个巨大的免费建材市场。别人已经把砖切好了、瓷砖贴好了。你不用从零烧砖--拿来拼就行。而你让 AI 去"逛市场"和"搬砖回来砌好"。

关键操作:当你看到喜欢的东西,把它的 GitHub 网址复制给 AI,说"参考这个来做"。AI 会去看那个仓库的代码,然后帮你实现类似的效果。

GitHub:版本管理 + 绿点日历

版本管理:后悔药

GitHub 的核心能力之一是版本管理--每次你推送更新,它都会保存一个"快照"。这意味着:

  • 今天改坏了?随时回滚到昨天的版本
  • 想看上周改了什么?版本对比一目了然
  • 不确定新改动好不好?可以随时切换新旧版本对比

就像写文档时的"撤销"功能,只不过它能撤销到任何时间点。

绿点日历:你的作品时间线

每次推送更新(哪怕改了一个错别字),那天就会亮一个绿点。三个月后回头看,你能清楚地看到:什么时候开始的?中间在做什么?进度如何?

越绿 = 那天更新越多。每个方块 = 一次版本快照。

对非技术人士来说,这可能是第一次有一个「可视化的产出记录」--而且别人也能看到。未来有人想了解你在做什么,这就是最好的名片。

Skill:请专家帮你改稿

你的手册已经在线了。内容有了,排版有了,还能访问了。但--质量能不能再上一个台阶?

想象一下这个场景:你写了一份产品说明,然后分别找了--

  • 一个专业编辑帮你改措辞
  • 一个设计师帮你审排版
  • 一个SEO专家帮你优化搜索

现实里这要花多少钱、找多少人?

Skill 就是"AI 的专家外挂"。

有人把自己最擅长的事情--写作、排版、检查语法、优化结构--打磨成了一个"技能包",然后说:"来,免费拿去用。"

这是开源世界最动人的事情之一。你不需要认识那个人,不需要付费,你的 AI 装上这个 Skill 之后,就像多了一个帮手的专业视角。

如果 AI 是一个多面手助理,Skill 就是"请三个专家帮你改稿"。多面手初稿,专家润色。

动手:安装第一个 Skill

不同的 AI agent 工具安装 Skill 的方式略有不同,但核心逻辑一样:找到→安装→使用。

PROMPT 我想给你安装一个 Skill 来提升写作质量。 请帮我找一个适合"检查文档结构和措辞"的 Skill, 并告诉我怎么安装和使用它。

或者,如果你已经知道想要什么:

PROMPT 请帮我搜索并安装一个前端设计相关的 Skill。 安装后,用它来审视我当前的 HTML 页面,给出改进建议。
AI 会搜索可用的 Skill 列表,找到合适的,安装后告诉你"已安装"。之后它在帮你做相关任务时,会自动调用这个 Skill 的能力。

Skill 是累积的--装得越多,你的 AI 助手越"全面"。就像一个团队在不断扩招专家。

串联:完整工作流

现在让我们把四把钥匙串在一起,看完整的从想法到上线的路径:

1. Markdown 列框架 → 审视结构 2. 逐章填充内容 → 确认完整性 3. HTML+SVG 做呈现 → 视觉验收 4. GitHub 发布 → 拿到网址 5. Skill 提升质量 → 迭代优化 循环迭代

注意那条红色虚线--这是一个循环。Skill 给出的建议可能让你回去改 Markdown 结构,或者调整 HTML 呈现。每一轮循环,质量上一个台阶。

但记住:先发布,再迭代。不要追求一步到位。60分的东西先上线,比100分的东西永远在本地强。

实战:从零到发布

如果你从头开始,以下是一次完整的对话流:

PROMPT 1 我要做一份"[主题]"的在线手册。 请先用 Markdown 帮我列出整体框架(章节 + 每章要点)。 不要写具体内容,只要骨架让我审视。

→ 审视结构,提出修改意见。可能来回2-3轮。

PROMPT 2 框架确认。请逐章展开内容,先写第一章。 保持 Markdown 格式,每章写完我确认后再写下一章。

→ 逐章确认,保持掌控。

PROMPT 3 所有内容确认完毕。现在请把它转成一个完整的 HTML 网站。 要求: - 翻页式或长滚动式均可(你判断哪个更适合) - 配上 SVG 示意图 - 适合手机阅读 - 输出文件结构:index.html + css/style.css + js/app.js

→ 验收视觉效果,提修改意见。

PROMPT 4 页面完成。请帮我把这些文件上传到我的 GitHub 仓库 [仓库名], 并开启 GitHub Pages,让我拿到在线访问地址。
完成!你现在拥有一个在线手册的网址,可以分享给任何人。整个过程你没写一行代码--你做的是"决策"和"验收"。

下一步去哪

手册做出来了,接下来你可能会想:

深化内容

隔一段时间回来加一章、改个措辞。GitHub 会记录每一次更新。你的手册是活的,不是一次交差的。

做第二个项目

同一套方法可以做任何东西:团队SOP、课程笔记、产品文档、个人博客。每个新仓库就是一个新项目。

去"建材市场"逛逛

在 GitHub 上搜你感兴趣的关键词。看看别人怎么做的。找到喜欢的?Fork 一份(就是复制到你自己那里),然后让 AI 帮你改成自己的。

给别人看你做的

把网址分享出去。收集反馈。"哪里看不懂?""哪里想了解更多?"--然后迭代。这就是"用作品说话"。

你已经有了工具链和方法论。剩下的只是"做"。

闭环

还记得第一页说的吗?

"你正在看的这个页面--翻页式、有配图、手机上也能看--就是用这套方法做出来的。"

现在你走完了整条路,回头看看这个教程本身:

  • 内容结构?Markdown 先列框架,逐章审视
  • 视觉呈现?HTML + CSS + SVG,一行代码没手写
  • 在线访问?GitHub Pages,免费发布
  • 质量保障?Skill 加持,迭代打磨

这个教程本身就是方法的产物。如果它看起来还不错--那这套方法就是有效的。

现在轮到你了。