@vuepress-denaro/vuepress-plugin-autodoc

vuepress-plugin-autodoc

🎉 Generate javascript documentation with jsdoc.使用 jsdoc 生成 javascript 文档.

Usage

• Install

# npm
npm install @vuepress-denaro/vuepress-plugin-autodoc

# yarn
yarn add @vuepress-denaro/vuepress-plugin-autodoc

• Update plugins in .vuepress/config.js or .vuepress/config.ts

js

const { autodocPlugin } = require('@vuepress-denaro/vuepress-plugin-autodoc')
module.exports = {
  plugins: [
    autodocPlugin({
      rootPath: '', // Replacement path for '@root'
    }),
  ],
}

ts

import { autodocPlugin } from '@vuepress-denaro/vuepress-plugin-autodoc'
import { defineUserConfig } from '@vuepress/cli'

export default defineUserConfig({
  plugins: [
    autodocPlugin({
      rootPath: '', // Replacement path for '@root'
    }),
  ],
})

• Write markdown

@[autodoc]{@/.vuepress/vue-previews/demo.js}

Thanks

vuepress-plugin-autodoc