前言
在开发前端项目的过程中，我们通常会需要使用到各种各样的 npm 包来提升开发效率。而 bunnydo 是一款非常优秀的 npm 包，它可以帮助我们快速构建一个漂亮、优雅的文档站点。本文将针对 bunnydo 包的使用方法进行详细说明。
什么是 bunnydo
bunnydo 是一个基于 Vue.js 的静态文档生成器，它能够将 Markdown 格式的文档通过 webpack 打包为静态文件，之后我们就可以将它部署到 Github Pages 上。同时，bunnydo 还支持多主题、多语言等功能，可以让我们轻松定制自己的文档站点。
如何使用 bunnydo
安装 bunnydo
要使用 bunnydo，我们需要先将它安装到我们的项目中。在命令行中执行以下代码：
--- ------- -- -------
初始化项目
安装完成 bunnydo 之后，我们就可以使用它来初始化一个新的 bunnydo 项目了。在命令行中执行以下代码：
------- ---- --------------
其中， 为你要创建的项目名称。
编写文档
初始化项目完成之后，我们就可以在项目中编写我们的 Markdown 格式文档了。所有的文档都应该放在 docs 文件夹下，并且每个文档都应该以 .md 为后缀名。
bunnydo 还支持多语言的文档，如果需要使用多语言，可以将文档按语言分类，例如：
-----
---
--------
--------
---
--------
--------编辑配置文件
在搭建自己的文档站点之前，我们还需要编辑一下 bunnydo 的配置文件，以便满足我们的需求。配置文件位于项目根目录下的 config.js，常见的配置项包括：
title：文档站点的标题description：文档站点的描述theme：使用的文档主题locales：支持的语言列表
示例代码：
-------------- - -
------ --- ---------------
------------ ----- -- -- ------------- ------
------ ----------
-------- -
---- -
----- --------
------ --- ---------------
------------ ----- -- -- ------------- -----
--
------- -
----- --------
------ -------
------------ ----------
-
-
-构建文档站点
编辑好配置文件，我们就可以开始构建我们的文档站点了。在命令行中执行以下代码：
------- -----
执行完成后，我们就可以在项目根目录下的 dist 文件夹中找到生成的静态文件了。
部署静态站点
将生成的静态文件部署到 Github Pages 上非常简单。只需要将 dist 文件夹中的内容推送到 Github 上的 gh-pages 分支就可以了。
-- ---- --- ---- --- --- -- --- ------ -- -------- --- ---- -- ------------------------------------------ ---------------
其中，<username> 为你的 Github 用户名，<repository> 为你的 Github 仓库名。
结论
bunnydo 是一个非常优秀的文档生成器，它能够方便快捷地帮助我们构建优雅的文档站点。如果你正在寻找一款文档生成器，或者正在考虑将你的文档站点升级到一个新的水平，那么 bunnydo 绝对是一个值得尝试的选择。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/60066c8eccdc64669dde562b