每位开发者都经历过这种痛苦：凌晨 2 点调试代码，WiFi 突然断了，偏偏找不到那段关键的 API 文档。或者在飞机上，想利用时间工作，却发现需要的文档只能在线访问。

解决方案？将 API 文档保存为 Markdown，随时离线查阅。

为什么开发者需要离线文档

1. 网络问题

在飞机、火车或偏远地点工作
几乎无法使用的会议 WiFi
屏蔽特定网站的咖啡店网络
连接文档站点的生产故障

2. 文档随时变更

API 文档会在毫无警示的情况下变化：

接口被弃用
出现破坏性变更
版本迁移
公司下线产品

拥有本地副本意味着您永远不会措手不及。

3. 更快的参考查阅

本地 Markdown 文件：

可用文本编辑器即时搜索
无需等待网络延迟即可导航
可添加您自己的注释
可从命令行 grep 搜索

文档即代码的理念

现代文档遵循”文档即代码”方法：

Markdown 源文件放入版本控制
静态网站生成器如 Docusaurus、Hugo、MkDocs
Git 工作流用于变更和审查
CI/CD 用于部署

将文档保存为 Markdown，等于在使用大多数技术文档本身已采用的源格式。

应保存哪些内容

基础开发者文档

API 参考 — 接口描述、参数、响应
SDK 文档 — 方法签名、示例、最佳实践
架构指南 — 系统设计、数据流、集成
故障排查指南 — 常见错误、调试步骤
迁移指南 — 版本升级说明

值得归档的热门文档

AWS、GCP、Azure 服务文档
Stripe、Twilio、SendGrid API 参考
React、Vue、Angular 框架指南
PostgreSQL、MongoDB、Redis 文档
Docker、Kubernetes 运维指南

如何用 Save 保存文档

导航到需要的文档页面
点击 Save 浏览器工具栏按钮
下载 Markdown 文件
整理到本地参考资料库

保留的内容

Save 干净地提取文档内容：

带语法高亮的代码示例
API 接口表格
参数说明
响应模式
嵌套标题结构
内联链接（转换为 Markdown 格式）

移除的内容

导航侧边栏
搜索组件
Cookie 同意横幅
版本切换器
页脚杂项

构建您的参考资料库

为保存的文档创建结构化系统：

~/docs/
├── apis/
│   ├── stripe/
│   │   ├── payments.md
│   │   ├── subscriptions.md
│   │   └── webhooks.md
│   └── twilio/
│       ├── sms.md
│       └── voice.md
├── frameworks/
│   ├── react/
│   └── nextjs/
└── infrastructure/
    ├── docker/
    └── kubernetes/

开发者专业技巧

1. 为文档添加版本标注

在文件名中包含日期或版本号：

stripe-payments-2025-01.md
react-hooks-v18.md

2. 添加您自己的注释

Markdown 允许您在保存的文档中添加注释：

<!-- 我的注释：此接口在生产环境中需要幂等键 -->

3. 与 AI 助手配合使用

保存的文档是很好的 AI 上下文：

保存相关文档
粘贴到 Claude 或 ChatGPT
提问具体的实现问题
获得以文档为依据的准确回答

4. 创建快速参考卡片

将最常用的信息提取到摘要文件中：

# Stripe 快速参考

## 创建支付意向
POST /v1/payment_intents
必填参数：amount, currency

## Webhooks
始终使用以下方法验证签名：
stripe.webhooks.constructEvent(...)

适合技术写作者

如果您撰写文档，Save 可以帮助您：

分析竞品文档 — 了解他人如何组织信息
创建风格参考 — 保存优秀文档示例
构建培训材料 — 为入职培训编制文档
内容审核 — 跨版本比较文档

立即开始构建离线资料库

不要等到下次断网危机。现在就构建您的离线文档参考资料库。

从 Chrome 网上应用店安装 Save — 一键将任意文档页面保存为简洁的 Markdown。

有问题？请发邮件至 [email protected] 联系我们