简介
esdoc-inject-style-plugin是一个npm包，为Esdoc提供了一个用于注入自定义CSS样式的插件。Esdoc是一个JavaScript文档生成工具，可以将您的ES6/ES7代码生成易于阅读的文档。
安装
使用npm包管理器进行安装：
npm install esdoc-inject-style-plugin
配置
在esdoc配置文件中，添加以下属性：
{
"plugins": [
{"name": "esdoc-inject-style-plugin", "option": {"style": "path/to/your/style.css"}}
]
}其中，"path/to/your/style.css"是您自定义的样式文件路径。
使用
在您编写的JsDoc注释中，添加以下标签：
/**
* @css {string} - 设置CSS样式字符串
* @cssfile {string} - 设置CSS文件路径
*/例如：
/**
* @css
* .my-class { background-color: red; }
*/
class MyClass {}或者：
/**
* @cssfile path/to/your/style.css
*/
class MyClass {}示例
-- -------------------- ---- -------
---
- - ------ ----- ---------- - -------
- ----
- ------- - ------- --- ----- ------ -------- ----- -
--
----- ------ -
---
- ------ - ------
- ------ -------- ---- - --- -------- ----
- ------ -------- --- - --- -------- ---
--
----------------- ---- -
--------- - -----
-------- - ----
-
-在注释中添加@css标签，定义一个CSS样式。
-- -------------------- ---- -------
---
- - ------ ----- ---------- - -------
- -------- ----------------------
--
----- ------ -
---
- ------ - ------
- ------ -------- ---- - --- -------- ----
- ------ -------- --- - --- -------- ---
--
----------------- ---- -
--------- - -----
-------- - ----
-
-在注释中添加@cssfile标签，定义一个CSS文件。
结论
使用esdoc-inject-style-plugin插件，您可以轻松地为您的Esdoc生成的文档自定义CSS样式。这为将您的文档整合到您的项目中提供了很大的灵活性和自定义性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedc987b5cbfe1ea061237b