Repolode
srcbookdev

srcbookdev/srcbook

一款在本地运行的 TypeScript 笔记本,提供网页界面,并可选配 AI 辅助功能。

可替代:Jupyter Notebook

Star
3,436
Fork
309
未关闭 Issue
32
最近提交
3个月前

这是什么?

Srcbook 是一款用于编写和运行 TypeScript 代码的笔记本。它以本地 CLI 应用的形式启动并提供网页界面,笔记本和代码执行都在你自己的机器上进行。笔记本以 .src.md 格式的 Markdown 文件保存,便于在应用之外阅读和迁移。

除了运行代码单元,Srcbook 还支持用 Mermaid 绘制图表来标注笔记,并提供 AI 功能辅助探索和迭代想法。使用 AI 需要自备 API Key,项目推荐 Anthropic 的 claude-3-5-sonnet-latest 模型。它也可以通过 Docker 运行,并可用 npx 或全局 npm 安装启动。

项目采用 Apache-2.0 协议开源,维护者说明该项目已不再积极开发。

核心功能

  • 01在浏览器中创建、运行和分享 TypeScript 笔记本。
  • 02将笔记本保存为 Markdown(.src.md)文件。
  • 03使用自备的 API Key 通过 AI 功能探索和迭代想法。
  • 04用 Mermaid 图表为笔记添加标注。
  • 05通过 CLI 启动本地网页界面,并支持 Docker 运行。

适用场景

  • 快速验证 TypeScript 或 Node.js 代码片段,并将结果与说明放在一起保存。
  • 编写带文档的可运行示例,并以纯 Markdown 文件分享。
  • 借助 AI 助手探索想法,同时将代码执行保留在本地。

快速上手

  1. 1

    确认已安装 Node 18+ 和 corepack

  2. 2

    使用 npx 运行 Srcbook(始终为最新版本)

    npx srcbook@latest start
  3. 3

    打开网页界面并设置你的 API 密钥

使用前须知

  • 维护者表示 Srcbook 已不再积极开发。
  • 使用 AI 功能需要自备 API 密钥。

标签

常见问题

srcbook 是什么?
一款在本地运行的 TypeScript 笔记本,提供网页界面,并可选配 AI 辅助功能。 Srcbook 是一款用于编写和运行 TypeScript 代码的笔记本。它以本地 CLI 应用的形式启动并提供网页界面,笔记本和代码执行都在你自己的机器上进行。笔记本以 .src.md 格式的 Markdown 文件保存,便于在应用之外阅读和迁移。
srcbook 可以免费使用吗?用的什么许可证?
srcbook 以 Apache-2.0 许可证开源。用于商业产品前,请先确认许可证条款。
srcbook 还在维护吗?
半年内有更新。srcbook 最近一次提交是在 2026年7月30日。
srcbook 适合用来做什么?
快速验证 TypeScript 或 Node.js 代码片段,并将结果与说明放在一起保存。 编写带文档的可运行示例,并以纯 Markdown 文件分享。 借助 AI 助手探索想法,同时将代码执行保留在本地。
srcbook 怎么安装和运行?
确认已安装 Node 18+ 和 corepack 使用 npx 运行 Srcbook(始终为最新版本): npx srcbook@latest start 打开网页界面并设置你的 API 密钥
在哪里获取 srcbook?
源代码和安装说明在 GitHub 上:https://github.com/srcbookdev/srcbook

概要由 AI 根据项目 README 生成;GitHub 数据每日更新。

相关项目