在前端开发中，很多项目都会使用 GitHub 进行版本控制和协作开发，而 GitHub 的 README.md 文件通常是项目的入口和文档。如果我们需要从项目中获取该文件内容，则可以使用 npm 包 github-readme-getter。
本文将介绍 npm 包 github-readme-getter 的使用教程，包括安装、基本用法、高级用法，以及实际应用场景。
安装
npm 包 github-readme-getter 可以使用 npm 进行安装。在项目中执行以下命令即可安装该包：
npm install github-readme-getter
基本用法
获取指定 GitHub 仓库的 README.md 文件内容，只需要执行以下命令：
-- -------------------- ---- -------
----- --- - --------------------------------
--------------------------------------------------------
-------------- -- -
---------------------- ------- --------
--
-------------- -- -
---------------------- -------
---其中，getReadmeContent 方法接收一个参数，表示要获取的 GitHub 仓库的 URL，获取到的 README.md 文件内容将作为 Promise 的返回值通过 then 方法传递。
如果需要获取本地仓库的 README.md 文件，可以传递文件路径的形式：
grg.getReadmeContent('./README.md')
.then((readme) => {
console.log('README.md 的内容是：', readme);
})
.catch((error) => {
console.error('获取失败：', error);
});高级用法
设置超时时间
当请求超时时，github-readme-getter 将抛出一个错误。可以使用 options.timeout 属性设置超时时间（以毫秒为单位）：
grg.getReadmeContent('https://github.com/username/repo', { timeout: 5000 })
.then((readme) => {
console.log('README.md 的内容是：', readme);
})
.catch((error) => {
console.error('获取失败：', error);
});传递 headers
可以使用 options.headers 属性传递请求 headers：
grg.getReadmeContent('https://github.com/username/repo', { headers: { 'Authorization': 'Bearer ' + token } })
.then((readme) => {
console.log('README.md 的内容是：', readme);
})
.catch((error) => {
console.error('获取失败：', error);
});发送代理请求
可以使用 options.proxy 属性配置请求代理：
grg.getReadmeContent('https://github.com/username/repo', { proxy: 'http://127.0.0.1:8888' })
.then((readme) => {
console.log('README.md 的内容是：', readme);
})
.catch((error) => {
console.error('获取失败：', error);
});实际应用场景
自动化生成项目的文档
在一些开源项目中，README.md 文件通常是项目文档的入口。使用 github-readme-getter，我们可以在项目的构建脚本中自动获取该文件的内容，并将其插入到项目中的文档页面中。
-- -------------------- ---- -------
----- --- - --------------------------------
----- -- - --------------
----- ---------- - --------------
----- -------- - ------------------
-----------------------------------
-------------- -- -
----- ----------- - -
- ----
--------------------------- ------
-- --
------
-- --
-----
-- ----
-----
-- ---
--- ---
-- ----
-----
-- --
---
---------
--
-------------------------- ------------ ---------
-----------------------
--
-------------- -- -
----------------- --------- ----- -------
---运行该脚本后，README.md 文件的内容将被自动插入到项目文档的最后面。
总结
github-readme-getter 是一个很实用的 npm 包，在前端开发中能够大大简化获取 GitHub 仓库 README.md 文件内容的过程。本文介绍了该包的基本用法和高级用法，以及实际应用场景，希望能够对读者有所帮助。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005541381e8991b448d16ca