Typedef не отображается в шаблоне при использовании gulp-jsdoc-to-markdown

Я пытаюсь создать автоматически сгенерированную документацию для нашего API node.js. Я использую комментарии в стиле jsDoc и gulp для запуска поколения. Я использую плагин jsdoc2md и этот плагин gulp для создания документации по стилю уценки.

Я сталкиваюсь с проблемой того, что мои typedefs не отображаются в сгенерированной документации, когда я пытаюсь использовать шаблон. Они появляются, когда я не использую шаблон

Вот глоток

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}}

Результатом этого является уценка с соответствующими функциями и модулями, но без определения типа. Итак, мой вопрос:

Как я могу получить мои typdefs для отображения в шаблоне?

В документации не так много. Есть идеи?

0 ответов

Другие вопросы по тегам