Giter Club home page Giter Club logo

pre-vuese's Introduction

vue组件文档自动生成

基于 vuese

安装

npm install vuese -D

使用

生成文档

vuese gen

或则写入package.json中

"scripts": {
  "docs": "vuese gen"
}
npm run docs

使用配置文件

根据目录创建.vueserc 或 vuese.config.js

{
  "include": "./src/components/*/*.vue", // 包含的文件
  "outDir": "docs", // 文档的输出目录
  "markdownDir": "components",
  "title": "Component UI Api", // 生成组件文档index的title
  "exclude": ["node_modules/**/*.vue"] // 排除的文件,node_modules已被默认排除
}

预览组件文档

vuese serve --open

相应式预览单个组件文档

vuese preview ./src/components/*/*.vue

pre-vuese's People

Contributors

czj306 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.