什么是 mr-doc？
mr-doc 是一款基于 JavaScript 的 npm 包，她能快速、准确地生成项目文档，并帮助团队易于沟通和协作开发。
如何使用 mr-doc？
安装
首先，需要使用 npm 或者 yarn 来安装 mr-doc。
npm install -g mr-doc
或者
yarn global add mr-doc
配置
接下来，在你的项目根目录下新建一个名为 mr-doc.config.js 的配置文件，在其中添加以下代码。
-- -------------------- ---- -------
-------------- - -
------ ----------------- ---- --- -------
------- ---------
-------- -------------------
------ --- ------- ------- ----------
---- -----
---- -
- ------ ----- ---- --- --
- ------ ---- ---- ---- ------ --
- ------ ------- ---- -------- -
--
-------- -
-- -----
--
------------ -
-- -------
-
-其中：
input：需要生成文档的文件或文件夹路径，支持通配符。exclude：需要排除生成文档的文件或文件夹路径，支持通配符。output：生成文档所在的目录路径。title：文档首页的标题。toc：是否生成目录导航。nav：页面头部的导航条。plugins：使用的插件。themeConfig：主题配置。
运行
在配置完成之后，运行以下命令即可开始生成文档。
mr-doc
默认情况下，生成的文档将会被输出到配置文件中指定的 output 目录下。
自定义插件
mr-doc 提供了插件系统，允许您在生成文档的过程中添加自定义功能。
以添加 markdown 渲染器为例，新建一个名为 markdown-plugin.js 的文件，并添加以下代码。
const md = require('markdown-it')()
module.exports = {
render(markdown) {
return md.render(markdown)
}
}然后，在配置文件中添加以下代码，启用刚刚新建的插件。
plugins: [
{ path: './plugins/markdown-plugin.js' }
]现在，所有以 .md 结尾的 markdown 文件都会使用 markdown-it 来进行渲染。
自定义主题
mr-doc 内置了多套主题，但大多数项目都需要一些个性化的需求，您可以轻松定制主题，满足特定的需求。
以添加一个新的代码高亮主题为例，新建一个名为 new-theme.scss 的文件，并添加以下代码。
-- -------------------- ---- -------
--- -
----------------- --------
-------- -----
---- -
------------ -------- ----- -------- ----------
------ -----
-
------------- -
------ ------------
-
----------- -
------ -----
-
--------------
-------------------
----------- -
------ -----
-
-------------
--------------
---------------
------------------------
--------- ---------- -
------ -----
-
-------------
------------ -
------ -----
-
------------
--------------
----------------- -
------ -----
------------ -----
-
----------- -
------------ -------
-
-----------
----------- ----------- -
------ -----
------------ -----
-
----------
-----------
--------------- -
------ --------
------------ -------
-
-------------
---------- -
------ --------
-
-------------
------------ -
------ --------
-
---------------
------------------ -
------ --------
-
---------- -
------ -----
------------ -----
-
-------------- -
----------- -----
-
-------------- -
----------- -----
-
-------------- -
----------- -------
-
------------ -
------------ -----
-
-然后，在配置文件中添加以下代码，启用新的主题。
themeConfig: {
path: './sass/new-theme.scss'
}现在，所有代码块都会使用新的代码高亮主题进行渲染。
结语
在本文的指导下，您已经学会了如何使用 mr-doc 来生成项目文档，并且了解了如何添加自定义插件和主题。希望这篇文章对您有所帮助，祝您在前端开发的道路上越走越远！
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/189926