https://github.com/ymfe/ydoc-plugin-esdoc

使用 esdoc 解析 api 生成
https://github.com/ymfe/ydoc-plugin-esdoc

Last synced: 8 months ago
JSON representation

使用 esdoc 解析 api 生成

• Host: GitHub
• URL: https://github.com/ymfe/ydoc-plugin-esdoc
• Owner: YMFE
• Created: 2018-05-29T06:53:55.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-05-29T06:55:51.000Z (over 7 years ago)
• Last Synced: 2025-02-18T01:43:15.159Z (11 months ago)
• Language: JavaScript
• Size: 10.7 KB
• Stars: 0
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# ydoc-plugin-esdoc

根据代码生成注释，丰富的插件满足你的需要。

## 用法

在项目目录下 install 插件：

```

npm install ydoc-plugin-esdoc

```

在项目根目录 `ydoc.js` 中配置插件参数, `.esdoc.json`中的配置放在这里即可：

```

module.exports = {

  plugins: ['esdoc'],

  pluginsConfig: {

    esdoc: {

      source: "./yis-js",

      destination: "./docs/api",

      plugins: [

        { name: "esdoc-standard-plugin" },

        { name: "esdoc-ecmascript-proposal-plugin", option: { all: true } },

        { name: "esdoc-jsx-plugin", option: { enable: true } },

        { name: "esdoc-flow-type-plugin", option: { enable: true } }

      ]

    }

  }

}

```

## esdoc 参考

esdoc-feature: https://esdoc.org/manual/feature.html

esdoc: https://github.com/esdoc/esdoc

esdoc-plugins: https://github.com/esdoc/esdoc-plugins