我已经尝试过sassdoc,我喜欢它为我们的Sass mixins和函数生成文档。我找不到任何方法来为我们的sass变量生成文档,就像在输出html列出变量及其相应的十六进制/ RGB颜色时一样。
sassdoc是否可行,还是有另一个类似的节点软件包来做到这一点?
最佳答案
给出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());
});
结果: