如何将 SassDoc 数据导出为 Json 而不是 HTML

Question

我目前正在使用以下 gulp 函数，该函数使用 SassDoc^2.7.3 自动记录我所有的 Scss 代码。

const sassdoc = require('sassdoc')

//...

function documentScss() {
  var options = {
    dest: './public/sassdoc',
    verbose: true,
  }

  return src('./src/scss/**/*.scss').pipe(sassdoc(options))
}

在目录 ./public/sassdoc 内，会创建一个 index.html 文件和一个 assets 文件夹，因为这是 Sassdoc 的默认行为。我一直在寻找一个配置选项、主题或库，而不是创建一个具有相同内容的 .json 文件。我只是希望能够在其他 js 模块中使用我的 Sassdoc 文档，并且我认为在构建期间在 .json 文件中生成文档是最好的。

谢谢 :D

Answer 1

我没有使用 gulp 函数，而是使用 sassdoc cli 来完成。命令 sassdoc src/ --parse 会将 src 文件夹内的所有注释输出到终端。通过稍作修改，您可以将该输出转换为 .json 文件：

sassdoc src/ --parse > ./sassdoc.json

如何将 SassDoc 数据导出为 Json 而不是 HTML

How to export SassDoc data as Json instead of HTML

css

node.js

sass

gulp