SASSDOC

SASSDOC是一个基于注释的自动生成Sass库文档的工具。

安装

npm install sassdoc --save-dev

使用

1. 在Sass代码中添加注释，标记为需要生成文档的代码块：

/**
 * 按钮样式
 *
 * @group 模块名称
 * @element button 按钮
 * @sass
 *
 * .btn {
 *  color: #fff;
 * }
 *
*/

2. 运行sassdoc命令生成文档：

sassdoc [source_folder] [options]

3. 导出的文档为Markdown格式，可在浏览器中查看或导出为HTML。

标注

SassDoc支持标记以下类型的注释：

• @group 定义代码块所属组，一个@group只能有一条注释。
• @element 定义代码块所属元素，可多次使用。
• @sass 包含需要生成文档的Sass代码块。

示例

按钮样式

模块名称 / 按钮

.btn {
  color: #fff;
}

结论

SASSDOC是一个功能强大，易于使用的自动生成Sass代码库文档的好工具，仅需在Sass代码中加入适量注释即可生成详细的文档。