Srcbook

TypeScript 和 JavaScript 笔记本。

特性

• 创建、运行和分享可复现的程序和想法
• 导出为有效的 markdown 格式（.src.md）
• AI 功能，用于探索和迭代想法
• 带有网页界面的本地执行
• 由 Node.js 驱动
• 基于 Apache2 许可的开源项目

入门

Srcbook 作为一个带有网页界面的 CLI 应用程序在您的本地机器上运行。

要求

• Node.js v20+
• 我们建议使用 nvm 来管理本地 node 版本

安装

您可以从 npm 安装 srcbook 应用程序：

npm install -g srcbook

运行

srcbook start

您也可以直接使用 npx 运行：

# 使用 npx
npx srcbook start

# 使用 pnpm
pnpm dlx srcbook start

以下是当前可用的命令列表：

$ srcbook -h
用法：srcbook [选项] [命令]

Srcbook 是一个用于 TypeScript 的交互式编程环境

选项：
  -V, --version                 输出版本号
  -h, --help                    显示命令帮助

命令：
  start [选项]                  启动 Srcbook 服务器
  import [选项] <说明符>         导入 Srcbook
  help [命令]                   显示命令帮助

更新

您可以使用 npm 更新 srcbook：

npm update -g srcbook

卸载

您可以通过先删除包，然后清理其在磁盘上的本地目录来移除 srcbook：

npm uninstall -g srcbook
rm -rf ~/.srcbook

分析和跟踪

为了改进 Srcbook，我们收集一些行为分析数据。我们不收集任何个人或可识别的信息，我们的目标仅仅是改进应用程序。代码是开源的，所以您不必相信我们，您可以自行验证！您可以在我们的隐私政策中找到更多信息。

如果您想禁用跟踪，可以在应用程序的设置页面中进行操作。

开发

有关开发说明，请参阅 CONTRIBUTING.md。