使用gulp-jsdoc-to-markdown时,Typedef不会出现在模板中

时间:2016-05-03 16:27:44

标签: node.js gulp jsdoc jsdoc2md

我正在尝试为node.js API创建自动生成的文档。我正在使用jsDoc样式注释和gulp来运行代。我正在使用插件jsdoc2md和此gulp plugin来创建markdown样式文档。

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

这是gulp任务

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。所以我的问题是:

如何让我的typdef在模板中呈现?

文档没有太多内容。有什么想法吗?

0 个答案:

没有答案