1.0.2-alpha.4 • Published 3 years ago

@vuepress-denaro/vuepress-plugin-autodoc v1.0.2-alpha.4

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

vuepress-plugin-autodoc

:tada: 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

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