← 返回博客

开发者笔记:将技术内容保存为以代码为先的 Markdown

· Save Team
developercodedocumentationapitemplates

凌晨 2 点调试代码,找到了那个 Stack Overflow 的回答。您需要代码块、解释,仅此而已。不需要 47 条”我也是”的评论,不需要侧边栏广告,不需要相关问题走马灯。

Save 的开发者模板会过滤掉一切,只保留开发者真正需要的内容:代码、API 参考和技术上下文。

开发者阅读技术内容的痛点

技术内容在网络上被噪音淹没:

  • Stack Overflow — 回答被投票、评论、广告包围
  • 文档 — 重要代码被大段解释文字掩埋
  • 博客教程 — “首先,让我告诉你为什么我喜欢 JavaScript……”
  • GitHub README — 您需要的那个代码示例在 400 行以后
  • API 参考 — 有用的表格隐藏在文字墙中

开发者模板的工作原理

Save 的开发者模板输出以代码为先的格式,包含五个章节:

  1. TL;DR — 用一句话给出解决方案
  2. 概述 — 无废话的技术上下文
  3. 代码示例 — 每个代码块完整保留
  4. API 参考 — 包含方法、参数、返回类型的表格
  5. 注意事项 — 边缘情况、已知问题、版本特定行为

所有代码块均保留语法高亮标记,技术术语保持原样,营销语言被移除。

示例输出

来自 Next.js 关于 Server Actions 的文档页面:

## TL;DR

Server Actions 是在服务器上运行的异步函数,使用 'use server' 指令定义,可直接从客户端组件调用。

## 概述

Server Actions 消除了大多数变更场景中对 API 路由的需求,与 Next.js 的缓存和重新验证系统集成。仅在 App Router 中可用。

## 代码示例

### 基本 Server Action

\`\`\`typescript
'use server'

export async function createPost(formData: FormData) {
  const title = formData.get('title') as string
  await db.posts.create({ data: { title } })
  revalidatePath('/posts')
}
\`\`\`

### 在客户端组件中使用

\`\`\`typescript
'use client'

import { createPost } from './actions'

export function PostForm() {
  return (
    <form action={createPost}>
      <input name="title" />
      <button type="submit">创建</button>
    </form>
  )
}
\`\`\`

## API 参考

| 函数 | 参数 | 返回值 |
|------|------|--------|
| revalidatePath | path: string | void |
| revalidateTag | tag: string | void |
| redirect | url: string | never |
| cookies() | 无 | ReadonlyRequestCookies |

## 注意事项

- Server Actions 必须是异步函数
- 'use server' 指令可在函数级或文件级使用
- 请求体最大限制:默认 1MB
- 支持渐进式增强(无需 JS)
- 不能在客户端组件文件中定义

完美适用场景

保存 Stack Overflow 回答

获取带代码块的已采纳回答,无 UI 杂乱内容。非常适合构建个人代码参考资料库。

文档快照

在文档更改之前保存版本。已弃用的 API、迁移指南——保留本地副本。

教程提取

将编程教程提炼为核心步骤和代码,去除作者背景故事和 SEO 填充内容。

API 参考收藏

通过以开发者格式保存参考页面来构建个人 API 速查表,表格输出即可直接使用。

代码审查上下文

在审查不熟悉的代码时保存相关文档,在 PR 评论中分享开发者格式的参考资料。

设置方法

  1. 安装 Save,从 Chrome 网上应用店免费获取
  2. 打开设置,选择 “开发者 💻”
  3. 访问任意技术页面 — 文档、Stack Overflow、教程
  4. 点击 Save — 立即获得以代码为先的 Markdown
  5. 存入您的库 — Obsidian、VS Code 笔记、GitHub Wiki

专为开发者打造

不要再手动复制代码块,不要再重新格式化文档,不要再为找到一条需要的命令而浏览冗长的教程。

Save 的开发者模板从任意技术页面生成以代码为先的 Markdown,简洁、结构化、即可使用。

在 Chrome 网上应用店免费试用 Save