在前端开发中，使用好的文档生成工具可以让我们的文档更加美观而且易于维护。docma-template-zebra 就是一个针对开发文档生成器 Docma 的模板，它提供了一种类似于 Zeplin 的 UI 风格，让我们的文档更加美观而且易于理解。下面就是 docma-template-zebra 的使用教程。
安装
首先，需要全局安装 Docma：
--- ------- -- -----
然后，使用 npm 安装 docma-template-zebra：
--- ------- --------------------
使用
使用 docma-template-zebra 非常简单，只需要在 docma 的配置文件中设置一个 template 属性即可。比如，我们有一个项目放在了 ~/project 目录下，然后我们在这个目录下新建一个 .docma.json 配置文件：
- ------ -------- ------- --------- ----------- ---------------------- -
这里的 src 是要生成文档的源代码目录，dest 是生成文档的目标目录。然后，我们只需要在 ~/project 目录下执行以下命令即可生成文档：
----- -----
如果想要生成静态文件，可以执行以下命令：
----- -----
然后，我们就可以在 ~/project/docs 目录下看到生成的文档了。默认情况下，docma 会将项目中的所有 .md 文件都加入到生成的文档中。
修改配置
docma-template-zebra 的配置也非常简单，只需要在 .docma.json 文件中添加 templateData 属性即可。比如，我们想要修改默认的 logo 和文档中的标题，可以这样写：
-
------ --------
------- ---------
----------- -----------------------
--------------- -
------- -------------------
-------- --- ---------
-
-示例代码
下面是一个使用 docma-template-zebra 生成的文档实例：
总结
docma-template-zebra 是一个非常简单易用的文档生成模板，它可以让我们的文档更加美观而且易于维护。希望这篇文章能够对你有所帮助。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/69477