Skip to main content
本示例介绍如何从 GitHub 仓库加载数据。 你可以将 GITHUB_ACCESS_TOKEN 环境变量设置为 GitHub 访问令牌,以提高速率限制并访问私有仓库。

设置

GitHub 加载器需要 ignore npm 包 作为对等依赖。安装方法如下:
npm

用法

加载器将忽略二进制文件,如图像。

使用 .gitignore 语法

要忽略特定文件,你可以在构造函数中传入 ignorePaths 数组:

使用不同的 GitHub 实例

你可能希望针对与 github.com 不同的 GitHub 实例,例如,如果你的公司使用 GitHub 企业版实例。 为此,你需要两个额外的参数:
  • baseUrl - 你的 GitHub 实例的基础 URL,因此 githubUrl 匹配 <baseUrl>/<owner>/<repo>/...
  • apiUrl - 你的 GitHub 实例的 API 端点 URL

处理子模块

如果你的仓库包含子模块,你需要决定加载器是否应该跟踪它们。你可以通过布尔参数 processSubmodules 来控制。默认情况下,不处理子模块。 请注意,处理子模块仅在同时将 recursive 参数设置为 true 时有效。
请注意,加载器不会跟踪位于与当前仓库不同的另一个 GitHub 实例上的子模块。

流式处理大型仓库

对于需要以内存高效的方式处理大型仓库的情况。你可以使用 loadAsStream 方法异步流式传输整个 GitHub 仓库的文档。