ydoc-plugin-jsdoc

ydoc-plugin-jsdoc

YDoc 插件，根据代码注释生成 API 文档

使用方法：

在项目目录下 install 插件：

npm install ydoc-plugin-jsdoc

在项目根目录 ydoc.js 中配置插件参数：

module.exports = {
  title: "ydoc-plugin-jsdoc",
  description: "ydoc-plugin-jsdoc description demo",
  author: "ymfe",
  plugins: ['jsdoc'],
  pluginsConfig: {
    jsdoc: {
      files: 'test/**/*.js', // 生成文档源目录
      loaders: [linkmd] // 高级用法 可省略 自定义标签 
    }
  }
}

配置自定义标签的 loader 执行函数：

function linkmd(templateData) {
  templateData.forEach(doclet => {
    if (doclet.customTags) {
      
      doclet.customTags.forEach(item => {
        if (item.tag == 'link-md') {
          const md = fs.readFileSync(item.value);
          doclet.description = doclet.description ? doclet.description + '\n' + md : md;
        }
      })
    }
  });
  return templateData;
}