前言
随着前端工具的日益丰富，我们需要一个简单易用、方便快捷的文档工具来帮助我们更好地管理项目。在众多的文档工具中，vigour-doc 是一个非常值得推荐的 npm 包，它可以帮助我们快速构建自己的文档，并且支持多种语言扩展。本文将分享 vigour-doc 的使用教程，希望能帮助各位前端开发者更加高效地运用这个工具。
安装 vigour-doc
首先，我们需要在本地安装 vigour-doc。使用 npm 命令即可完成安装：
--- ------- ---------- --
这里需要注意的是，在使用 vigour-doc 前，我们需要确保本地已经安装了 node 和 npm。
创建文档
安装完 vigour-doc 后，我们可以使用以下命令创建一个新的文档：
---------- ---- -----
这里的 myDoc 是你想要创建的文档目录名，可以根据自己的需要进行修改。创建完文档后，我们可以进入文档目录并启动文档：
-- ----- ---------- -----
这样就可以在本地启动一个基于 vigour-doc 的文档站点，我们可以在浏览器中输入 http://localhost:1234 来访问这个站点。
编写文档
vigour-doc 支持使用 Markdown 语法来编写文档，这是一个非常流行的轻量级标记语言。
在 vigour-doc 中，我们可以在文档目录下创建 docs 文件夹，并在该文件夹下创建一个名为 README.md 的文件来编写文档：
----- --- ---- - --- --------- --- ------------
下面是一个简单的示例如下：
- ----- ----- ------- ---------- --- -- -- - --------- ----------------------- - --------- --------------------------------------------
自定义页面
除了在 docs 文件夹下创建 README.md 文件来编写文档外，我们还可以在 docs 文件夹下创建其他的 .md 文件，这些文件可以自定义添加到导航栏中。
编辑 docs 文件夹下的 config.js 文件可以呈现一个自定义页面。例如，我们可以添加一个 guide.md 文件，然后在 config.js 中添加以下代码：
-------------- - -
---- -
-
------ -----
----- ----
--
-
------ -----
----- --------------
--
--
--这里的 nav 数组中，我们添加了一个 指南 导航栏，其 path 为 /docs/guide，即指向 guide.md 文件。
配置添加语言
vigour-doc 不仅支持 Markdown 语法编写文档，还支持一些编程语言，比如 JavaScript、CSS、HTML 等等。我们可以编辑 docs 文件夹下的 config.js 文件来添加语言。
-------------- - -
---------- -
-
----- -------------
------ ------ --------------
---------- -----
--
-
----- ------
------ ------
---------- ------
--
-
----- -------
------ -------- -------
---------- -------
--
--
--这里添加了 JavaScript、CSS、HTML 三种语言，并在数组中指定了它们的别名（在 Markdown 中使用代码块时可以省略后缀名），以及它们的后缀名。
结语
以上就是 vigour-doc 的基本使用教程，我们可以使用它来快速构建自己的文档，支持多种语言扩展，非常适合前端开发者使用。希望本文对大家有所帮助。更多详细内容，请参考 vigour-doc 官网。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/71432