npm 包 documentjs-github-download 使用教程-JavaScript中文网-JavaScript教程资源分享门户

在前端开发中，我们经常需要将代码文档化，以方便其他开发者阅读和理解我们的代码。而 documentjs-github-download 是一个非常好用的 npm 包，它能够帮助我们从 Github 上下载某个仓库的 Markdown 格式的文档，并在文档中自动添加导航，让我们的文档更加易读、易用。

安装

首先，我们需要安装 documentjs-github-download。可以使用 npm 进行安装：

npm install documentjs-github-download --save-dev

使用方法

在安装完成之后，我们需要修改配置文件 documentjs.json，以便使用 documentjs-github-download。

首先，在 documentjs.json 文件中添加一个名为 “githubDownload” 的属性，并设置为 true。
```
{
  "githubDownload": true
}
```
接着，添加 githubRepo 属性，设置为希望导入的 Github 仓库名称。例如，如果要导入 https://github.com/facebook/react 这个仓库，就需要设置为：
```
{
  "githubDownload": true,
  "githubRepo": "facebook/react"
}
```
注意：如果 Github 仓库是私有的，需要在 githubToken 中设置个人 access token。
然后，我们需要编写文档的 Markdown 文件，引入导航的方法如下：
```
[TOC]


```
这里的 TOC 是 Table of contents 的缩写，表示目录。上面的代码可以在某个 Markdown 文件中任何位置进行引用，会自动生成该文档的目录，方便查阅。
最后，运行 documentjs 命令即可生成文档，可以添加 --githubDownloadAsset 参数，让 documentjs-github-download 从 Github 中读取指定的文件。
```
documentjs --githubDownloadAsset /docs/README.md
```
运行完成之后，我们即可在文档中看到自动生成的目录，方便我们快速找到需要的内容。

示例

下面是一个简单的示例代码，以便更好地理解 documentjs-github-download 的使用方法：

`documentjs.json`

-- -------------------- ---- -------
-
  --------- -
    ----------------- -----------------
    ----------------- ---------------
  --
  ----------------- -----
  ------------- -----------------
  ---------- -
    -------------------
    --------------------------------------------------
  -
-

`docs.md`

-- -------------------- ---- -------
-----

- ----

-------------

-----
-------- ----------- -
  ------------------- -----------
-

### 运行

```shell
documentjs --githubDownloadAsset /docs.md

运行结果

运行完成之后，我们可以看到在生成的文档前面，自动生成了一个目录。

总结

通过 documentjs-github-download，我们可以轻松地从 Github 上下载文档并生成目录，方便我们阅读查找。虽然 documentjs-github-download 功能简单，但它的使用方法和示例代码都非常具有指导意义，希望本文可以对您的前端开发工作有所帮助。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/75806