# @builder\.io/gatsby 中文文档

规范地址：https://npmcn.com/package/%40builder.io/gatsby/

版本：4\.0\.0
npm 元数据更新时间：2026-09-09T09:16:40.252Z
中文译文更新时间：2026-11-08T19:04:34.792Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40builder.io/gatsby
原文对照：https://npmcn.com/package/%40builder.io/gatsby/?lang=original
项目主页：https://github.com/BuilderIO/builder/tree/master/packages/gatsby#readme
源码仓库：https://github.com/BuilderIO/builder

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：29.8 kB，11 个文件
- TypeScript 类型：未声明
- Node.js 要求：\>=14\.15\.0
- 运行依赖：9 个
- peer 依赖：gatsby \>= 4
- 首次发布：2020-02-25T23:50:43.274Z
- 最新版本发布：2024-01-12T09:45:12.329Z
- 近 30 天下载量：6526（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：65（近 12 个月 0 个）

## 中文简介

使用 Gatsby 的 Builder.io 插件

## 安装

```sh
npm install @builder.io/gatsby
```

也可以使用：`pnpm add @builder.io/gatsby`、`yarn add @builder.io/gatsby`、`bun add @builder.io/gatsby`

## README

# @ builder.io/ gatsby

集成插件 [构建者.io](https://www.builder.io/) 允许与 Gatsby 一起拖放页面。 它将构建者.io 计划置于一个 `allBuilderModels` gatsby GraphQL 查询的字段中,如果模板地图作为选项被传递,此插件将在指定的路径上为每个页面条目动态创建 Gatsby 页面.

![example](https://imgur.com/PJW3b4S.gif)

## 安装

`npm install @builder.io/gatsby`

## 如何使用

开个免费账户 [构建者.io](https://www.builder.io/) 从您的公共 API 密钥中获取 [组织页面](https://builder.io/account/organization) 和:

```javascript
// In your gatsby-config.js
const path = require('path');
module.exports = {
  plugins: [
    {
      resolve: '@builder.io/gatsby',
      options: {
        // public API Key
        publicAPIKey: 'MY_PUBLIC_API_KEY',
        // OPTIONAL
        // Set this to `true` to rely on our cached content. Default value is `false`, always fetching the newest content from Builder.
        useCache: false,
        // OPTIONAL
        // mapping model names to template files, the plugin will create a page for each entry of the model at its specified url
        templates: {
          // `page` can be any model of choice, camelCased
          page: path.resolve('templates/my-page.tsx'),
        },
        // OPTIONAL
        mapEntryToContext: async ({ entry, graphql }) => {
          const result = await graphql('....');
          return {
            property: entry.data.property,
            anotherProperty: entry.data.whatever,
            dataFromQuery: result.data
            /* ... */
          };
        },
        // OPTIONAL
        // to resolve a single entry to multiple, for e.g in localization
        resolveDynamicEntries: async (entries) => {
          const entriesToBuild = []
          for entry of entries {
            if (entry.data.myprop.isDynamic){
               entriesToBuild.push(await myEntryResolver(entry))
            }
            else {
               entriesToBuild.push(entry)
            }
          }
          return entriesToBuild;
        },
      },
    },
  ],
};
```

然后在Builder.io开始建立网页,点击发布,它们将会被录入你的Gatsby网站,在每个新的建筑上!

一个更先进的例子和开始检查 [gatsby- starter- 建设器](https://github.com/BuilderIO/gatsby-starter-builder)

## 使用编辑器中的组件

看这个 [设计系统实例](https://npmcn.com/examples/react-design-system) 使用您的 deisgn 系统+自定义组件的许多示例

👉**提示: 要将页面构建限制在您的组件吗 ? 尝试 [只有组件模式](https://builder.io/c/docs/guides/components-only-mode)**

注册一个组件

```tsx
import { Builder } from '@builder.io/react';

class SimpleText extends React.Component {
  render() {
    return <h1>{this.props.text}</h1>;
  }
}

Builder.registerComponent(SimpleText, {
  name: 'Simple Text',
  inputs: [{ name: 'text', type: 'string' }],
});
```

## 如何查询

最新完整的例子请检查 [Gatsby + 构建器.io 启动器](https://github.com/BuilderIO/gatsby-starter-builder)

```graphql
{
  allBuilderModels {
    myPageModel(options: { cachebust: true }) {
      content
    }
  }
}
```

## 学多点

-   [Gatsby + 构建器.io 启动器](https://github.com/BuilderIO/gatsby-starter-builder)
-   [设计系统实例](https://github.com/BuilderIO/builder/tree/main/examples/react-design-system)
-   [官方文件](https://www.builder.io/c/docs/getting-started)

## 常见问题

### @builder\.io/gatsby 是什么？

使用 Gatsby 的 Builder\.io 插件

### 如何安装 @builder\.io/gatsby？

在项目目录运行 npm install @builder\.io/gatsby，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：gatsby（\>= 4）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @builder\.io/gatsby 支持 TypeScript 吗？

该包的 package\.json 没有声明类型入口。需要类型提示时，可以在 npm 上查找社区维护的 @types/builder\.io\_\_gatsby 是否存在。

### @builder\.io/gatsby 需要什么版本的 Node\.js？

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

### @builder\.io/gatsby 可以商用吗？

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

### @builder\.io/gatsby 的下载量有多少？

根据 npm 官方下载统计，@builder\.io/gatsby 在 2026/10/09 – 2026/11/07 这 30 天内被下载 6,526 次，日均约 218 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @builder\.io/gatsby 还在维护吗？

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