0

我正在尝试为我们的 node.js API 创建自动生成的文档。我正在使用 jsDoc 样式的注释和 gulp 来运行生成。我正在使用插件jsdoc2md和这个gulp插件来创建降价样式文档。

当我尝试使用模板时，我遇到了我的 typedef 没有出现在生成的文档中的问题。当我不使用模板时它们会出现

这是吞咽任务

gulp.task("docs", function() {
    return gulp.src(["./documentation/typedefs.js", "./routes/**/*.js"])
        .pipe(concat("README.md"))
        .pipe(gulpJsdoc2md({ template: fs.readFileSync('./README.hbs', 'utf8') }))
        .on("error", function(err) {
            gutil.log(gutil.colors.red("jsdoc2md failed"), err.message);
        })
        .pipe(gulp.dest("./api"));
});

这是我的模板

# My Super Cool API
This is where stuff happens

# Search API
{{#module name="search-api"}}
{{>body~}}
{{>member-index~}}
{{>separator~}}
{{>members~}}
{{/module}}

其输出是带有适当功能和模块的降价，但缺少 typedef。所以我的问题是：

如何让我的 typdefs 在模板中呈现？

文档没有太多。有任何想法吗？

4

0 回答 0