如何将 GitHub README 和 Issue 保存为 Markdown

GitHub 是开源的家园——充满宝贵的文档、Issue 讨论和代码示例。虽然 GitHub 本身已经使用 Markdown，但将内容提取到你自己的笔记或文档中并不总是那么简单。以下是 Save 如何让这变得简单。

为什么要将 GitHub 内容保存为 Markdown？

即使 GitHub 内容已经是 Markdown 格式，你可能还是想要：

创建离线文档供参考
从多个来源构建项目 wiki
在 Issue 关闭前存档重要内容
汇编来自多个仓库的研究资料
将文档提供给 AI 助手

Save 从 GitHub 捕获的内容

README 文件

带格式的完整 README 内容
保留语法高亮的代码块
完整的表格和列表
维护的图片引用

Issue 和讨论

Issue 标题和描述
话题串中的所有评论
代码片段和日志
参考链接

Pull Request

PR 描述和变更
审查评论
关联 Issue

示例输出

# 项目名称

![构建状态](badge-url)

## 安装

\`\`\`bash
npm install project-name
\`\`\`

## 使用

\`\`\`javascript
const project = require('project-name');
project.doSomething();
\`\`\`

## 配置

| 选项 | 默认值 | 描述 |
|------|--------|------|
| debug | false | 启用调试模式 |
| timeout | 5000 | 请求超时（毫秒）|

使用场景

构建个人文档

汇编多个仓库的设置指南
创建快速参考表
从 Issue 构建故障排除指南

项目研究

比较不同项目解决类似问题的方式
分析各仓库的代码模式
为团队整理库的文档

Issue 追踪

存档已解决的 Issue 供将来参考
保存带完整上下文的错误报告
记录解决方法和解决方案

AI 开发辅助

将 GitHub 内容提供给 AI 助手以：

解释复杂文档
基于示例提出实现建议
根据类似问题调试 Issue

最佳实践技巧

适用于任何 GitHub 页面 — 仓库、Issue、PR、讨论
捕获代码块 — 带正确的语法格式
保留表格 — 文档中常见

GitHub 与原始 Markdown

虽然你可以从 GitHub 复制原始 Markdown，但 Save：

包含渲染内容（对生成的文档有用）
捕获完整的 Issue 话题串
也适用于 wiki 页面
处理 GitHub 特定的格式

开始使用

从 Chrome 网上应用店安装 Save — 提升你的开发工作流程。

有问题？请联系 [email protected]