使用SassDoc为sass变量生成文档？

Question

我尝试了sassdoc，我喜欢为我们的混音和函数生成文档。我找不到任何方法来为我们的sass变量生成文档，就像输出html列出变量及其相应的hex / rgb颜色一样。

这是否可以使用sassdoc，或者是否有其他类似的节点包来执行此操作？

Answer 1

给予description和/或@type annotation就足够了。

<强> example.scss

/// This is the color that should be used for coffee
/// @type Color
$coffee: #c0ffee;

<强> gulpfile.js

var gulp = require('gulp');
var sassdoc = require('sassdoc');

gulp.task('default', function() {
  return gulp.src('example.scss')
    .pipe(sassdoc());
});

<强>结果：