介绍
在前端开发过程中，我们可能都需要编写文档来描述我们的代码、API 接口等。但是，手动编写文档非常耗费时间和精力，因此我们需要一些工具来帮助我们自动生成文档。其中，@docume/ntary 是一款非常好用的工具。
@docume/ntary 是一款基于 Markdown 的文档生成工具，可以将我们编写的 Markdown 文件转换成漂亮的 HTML 文档。同时，它还支持多种主题、自定义 CSS 样式等功能，可以满足我们绝大多数文档需求。
在本文中，我将介绍如何使用 @docume/ntary 生成文档，并提供一些示例代码，希望对大家有所帮助。
安装和使用
首先，我们需要安装 @docume/ntary：
npm install -g @docume/ntary
然后，我们在项目根目录下创建一个 docs 目录用来存放我们的 Markdown 文件。
接着，我们需要编写 Markdown 文件，以 example.md 为例：
# Example 这是一个示例文档。
然后，我们在命令行中执行以下命令：
docume example.md
这将会在 docs 目录中生成一个名为 example.html 的文件，可以用浏览器打开查看效果。
如果我们需要自定义样式或者使用其他主题，可以在项目根目录创建一个名为 docume.config.js 的文件，例如：
-- -------------------- ---- -------
-------------- - -
------ ---------
------- -
----- -
------ ------
---------------- --------
-
-
-这将会将主题设置为 github，同时将文档背景设置为黄色、文本颜色设置为红色。更多配置信息可以参考文档。
示例代码
下面提供一些示例代码，包括如何自动生成函数文档和如何使用自定义主题。
自动生成函数文档
我们可以使用 JSDoc 注释来自动生成函数文档，从而可以自动化生成 JavaScript 文档。
以下面这个函数为例：
-- -------------------- ---- ------- --- - ------- - ------ -------- - - ----- - ------ -------- - - ----- - -------- -------- - ------ -- -------- ------ -- - ------ - - -- -
我们需要在注释中使用 @param 和 @returns 标签来描述函数的参数和返回值，然后在生成文档时，@docume/ntary 将自动生成文档。
自定义主题
可以使用自定义样式或者其他主题来自定义文档样式，例如：
-- -------------------- ---- -------
-------------- - -
------ ---------
------- -
----- -
------ ------
---------------- --------
-
-
-这将会将主题设置为 github，同时将文档背景设置为黄色、文本颜色设置为红色。
总结
@docume/ntary 是一款非常方便、好用的文档生成工具，可以帮助我们更轻松地编写文档。在本文中，我们介绍了如何安装和使用 @docume/ntary，并提供了一些示例代码来演示如何自动生成函数文档和如何自定义主题。希望本文对大家有所帮助，也希望大家可以使用 @docume/ntary 来更方便地编写文档。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/600671d430d0927023822a71