引言
在前端开发中，我们经常需要使用各种 npm 包来简化代码编写。但是，npm 包非常多，如何找到合适的包并使用它们呢？本文将介绍一个非常实用的 npm 包：gutendocs。通过本文的学习，你可以掌握如何使用 gutendocs 来生成漂亮的文档，并且将它们发布到 Github Pages 上。
gutendocs 是什么？
gutendocs 是一个简单易用、轻量级的 Markdown 文档生成器。它可以将 Markdown 文件转换成漂亮的 HTML 页面，并且支持一些特殊功能，如代码高亮、自动生成目录等。gutendocs 最大的特点是它支持将生成的 HTML 页面直接部署到 Github Pages 上，从而快速地构建一个漂亮的文档网站。
gutendocs 安装
使用 gutendocs 需要先安装它。在安装之前，你需要安装 Node.js 和 npm，如果你尚未安装，可以参考 官方文档 进行安装。安装完成后，在命令行中执行以下命令来安装 gutendocs：
npm install -g gutendocs
这里使用了 -g 参数，表示全局安装 gutendocs。安装完成后，你可以在命令行中输入 gutendocs 来验证是否安装成功。
gutendocs 使用
初始化
使用 gutendocs 需要在工作目录中初始化一个项目。在命令行中，切换到你希望初始化项目的目录中，然后执行以下命令：
gutendocs init这将在当前目录中生成一个包含一些默认文件的初始化项目。可以检查生成的文件夹结构，根据需要进行修改。
编写文档
在生成的文件夹中，以 Markdown 格式编写你的文档。gutendocs 支持一些特殊的 Markdown 语法，其中比较常用的是三个反引号 ``` 来包含代码块，以及 # 来表示标题。
在编写文档时，你可以将图片等其它文件存放在一个独立的文件夹中，然后在 Markdown 文件中使用相对路径来引用它们。
生成 HTML 文档
当你编写好 Markdown 文件后，可以通过以下命令来生成 HTML 文档：
gutendocs build这将在生成的目录中生成一个 dist 文件夹，其中包含了生成的 HTML 文件。你可以用浏览器打开其中的 index.html 文件来查看效果。
部署文档
当你满意于生成的 HTML 文档后，你可以将它们部署到 Github Pages 上，以便别人可以访问它们。在进行部署之前，你需要在 Github 上创建一个空白的仓库，并将其与本地文件夹连接起来。我们假设你已经完成了这一步。
在命令行中，执行以下命令：
npm run deploy这将自动将 dist 文件夹中的内容 push 到你的 Github 仓库中。你可以在仓库的 Settings 页面中找到部署的链接，从而访问你的漂亮文档网站！
示例代码
以下是一个简单的示例代码，用来演示 gutendocs 的使用：
-- -------------------- ---- ------- - ---- --------- --------- --- -- -- --------- --------- ----------------------- ------- --- ------- -- ---------展开代码
使用 gutendocs
安装完成后，我们可以使用 gutendocs 生成文档。在命令行中，先初始化一个项目：
gutendocs init然后，按照提示编写 Markdown 文件，最后执行以下命令生成 HTML 页面：
gutendocs build最后，使用以下命令将生成的页面部署到 Github Pages：
npm run deploy结论
如此简单、易用的文档生成器，你还等什么呢？赶快试试 gutendocs 吧！
## 总结 gutendocs 是一个非常实用的 Markdown 文档生成器，通过本文的学习，你可以掌握如何使用它。相信在日常开发中，gutendocs 能为你节省不少时间和精力，快速构建漂亮、规范的文档网站。如果你对本文有任何问题或建议，欢迎在评论区留言。 > 来源：[JavaScript中文网](https://www.javascriptcn.com/post/81861) ，转载请注明来源 [https://www.javascriptcn.com/post/81861](https://www.javascriptcn.com/post/81861)
