在前端开发中，我们经常需要记录和分享代码文档。如果你正在寻找一种简单易用的文档生成工具，那么 dokiv 就是一个不错的选择。
简介
dokiv 是一个基于 markdown 的文档生成工具，支持多种主题并且易于扩展。你可以通过安装全局 dokiv 包来快速生成静态文档站点。
安装
你可以使用 npm 全局安装 dokiv 包：
--- ------- -- -----
安装完成后，你可以通过如下命令检查是否安装成功：
----- --
使用
创建文档
首先，你需要在工作目录下创建一个新的 docs 文件夹，并在其中创建一个名为 index.md 的文件，并使用 markdown 语法编写文档内容。例如：
- ---- ---- ----- --------------- -- -- ----- --- ---- ----- ------------ ------- --- ------- -- -----
使用
使用 dokiv 创建文档非常简单，只需要在工作目录下运行以下命令即可：
----- -----
你将在输出文件夹中看到生成的文档站点，你可以将它们部署在您的服务器上。
--- ------ -- ----- -----------------------------
dokiv build
--- - ------- ------ - ------- ----------- ------------ ------ ------------------------------------------------ ------- -- -------------- ------- --- ----------- -----
你可以在浏览器中打开 http://localhost:8080/ 来预览你的文档站点。
配置主题
dokiv 带有一些内置的主题，它们的样式是极简的。但是，你可以在本地或者全局安装更多的主题，或者创建一个新的自定义主题。
使用内置主题
dokiv 内置了多个主题可以让你选择。你可以指定一个内置的主题名称来进行主题预览。例如：
----- ----- -- -----
在内置主题名称前面加上 -t，然后指定主题名即可。
使用自定义主题
你也可以创建自己的 dokiv 主题。使用 dokiv new-theme 命令，即可使用现有的主题作为基础创建自己的主题。
----- --------- --------------- ---------- ------
该命令将在当前工作目录下创建一个名为 my-custom-theme 的文件夹，并指定 purple 主题作为基础。创建后，你可以在该主题文件夹下的 layout 文件夹中修改模板。
修改完成后，你可以在 build 命令中使用 -t 选项来指定自定义主题名称：
----- ----- -- ---------------
路径
在默认情况下，dokiv 将生成文档站点到 /dist 目录下。该值可以在 dokiv.json 文件中配置。例如：
- --------- --------- -
这将会将静态站点输出到一个名为 my-docs 的文件夹下。
默认情况下，你的文档目录必须位于工作目录下的 /docs 目录中。该值也可以在 dokiv.json 文件中配置，例如：
- ------- ----------- -
这将会将文档路径更改为工作目录下的 /my-docs 目录。
结论
dokiv 是一个非常好用的文档生成工具。它可以帮助你轻松地创建和分享静态站点。通过本教程，你已经学习到了如何使用 dokiv，并对其中的一些高级功能有了一些了解。希望这篇文章对你有所帮助！
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/63391