@goodfellow-cms/github

中文文档

0.9.0发布于 2026/11/01MITTypeScriptES Module构建来源已验证

Edit a Goodfellow CMS site stored on GitHub, straight from the browser.

@goodfellow-cms/github

Edit a Goodfellow site stored on GitHub, straight from the browser: sign-in with an access token, publishing as single commits, conflict checks and deploy status.

import { github } from "@goodfellow-cms/github";

export default defineConfig({ blocks, backend: github({ repo: "your-name/your-site" }) });

Goodfellow is a website builder for people who aren't developers, with no server or database: pages are files in your own GitHub, GitLab or Bitbucket repository, edited in a visual editor built on Puck. To start a new site, run npm create goodfellow@latest my-site. See the documentation for everything else.

More in the docs: Hosts and business sites.

License

MIT

版本与发布记录

@goodfellow-cms/github 共发布 10 个版本，首次发布于 2026/10/09；过去 12 个月发布了 10 个版本。最新版本附带 npm provenance 构建来源证明，可追溯到公开的 CI 构建记录。

版本	发布日期	距今
`0.9.0`latest	2026/11/01	2 天前
`0.8.0`	2026/10/30	4 天前
`0.7.0`	2026/10/29	5 天前
`0.6.0`	2026/10/27	7 天前
`0.5.0`	2026/10/25	9 天前
`0.4.0`	2026/10/18	16 天前

关于 @goodfellow-cms/github 的常见问题

@goodfellow-cms/github 是什么？

编辑Goodfellow CMS站点存储在GitHub上，直接从浏览器。

如何安装 @goodfellow-cms/github？

在项目目录运行 npm install @goodfellow-cms/github，或使用 pnpm add / yarn add / bun add。

@goodfellow-cms/github 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

@goodfellow-cms/github 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module，更早的版本需要改用动态 import()。

@goodfellow-cms/github 需要什么版本的 Node.js？

package.json 的 engines 字段要求 Node.js ^22.23.4 || ^24.22.1 || >=26.12.1。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

@goodfellow-cms/github 可以商用吗？

@goodfellow-cms/github 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

@goodfellow-cms/github 还在维护吗？

最新版本 0.9.0 发布于 2026/11/01（2 天前）；至今共发布 10 个版本，其中过去 12 个月发布了 10 个；首次发布于 2026/10/09。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。