vue-docs
vue docs
Last updated 2 years ago by jerret321 .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install vue-docs 
SYNC missed versions from official npm registry.

vue-docs

让你的文档轻松成为一个 VUE SPA, 面向vue编程 ^_^

Install

// global
npm i vue-docs -g --registry=https://registry.npm.taobao.org

// or
npm i -g --registry=https://registry.npm.taobao.org

Config

默认可没有 docs.config.js, 若需要配置,按照下列操作

  • 在根目录创建 docs.config.js
  • 写入下列内容 docs.config.js
var path = require('path')
var webpack = require('webpack')
module.exports = {
    port: 9999,
    // your webpack config
    webpack: {
        resolve: {
            alias: {
                'vt-tabs': path.resolve(__dirname, 'src')
            }
        }
    },
    md: { dir: './' },
    vue: { dir: './docs' }
}

Start

// global
vue-docs start

// project
./node_modules/.bin/vue-docs start

Build Doc

// global
vue-docs build

// project
./node_modules/.bin/vue-docs build

Deploy

docs目录下的内容发布到 你的服务器即可访问, 发布到 github pages 可参考vt-tabs

ChanageLog

  • 增加 editorconfig, eslint编码规范
  • 增加 enableSw参数, 控制是否支持 serviceWorker

备注

请保证在使用vue-docs的时候, 项目中的 vue-loadervue-docs中的vue-loader major版本一致.

Reference

Current Tags

  • 1.5.6                                ...           latest (2 years ago)

46 Versions

  • 1.5.6                                ...           2 years ago
  • 1.5.5                                ...           2 years ago
  • 1.5.4                                ...           2 years ago
  • 1.5.3                                ...           2 years ago
  • 1.5.2                                ...           2 years ago
  • 1.5.1                                ...           2 years ago
  • 1.5.0                                ...           2 years ago
  • 1.4.9                                ...           2 years ago
  • 1.4.8                                ...           2 years ago
  • 1.4.7                                ...           2 years ago
  • 1.4.6                                ...           2 years ago
  • 1.4.5                                ...           2 years ago
  • 1.4.4                                ...           2 years ago
  • 1.4.3                                ...           2 years ago
  • 1.4.2                                ...           2 years ago
  • 1.4.1                                ...           2 years ago
  • 1.4.0                                ...           2 years ago
  • 1.3.5                                ...           2 years ago
  • 1.3.4                                ...           2 years ago
  • 1.3.3                                ...           2 years ago
  • 1.3.2                                ...           2 years ago
  • 1.3.1                                ...           2 years ago
  • 1.3.0                                ...           2 years ago
  • 1.2.9                                ...           2 years ago
  • 1.2.8                                ...           2 years ago
  • 1.2.7                                ...           3 years ago
  • 1.2.6                                ...           3 years ago
  • 1.2.5                                ...           3 years ago
  • 0.2.0                                ...           3 years ago
  • 1.2.4                                ...           3 years ago
  • 1.2.3                                ...           3 years ago
  • 1.2.2                                ...           3 years ago
  • 1.2.1                                ...           3 years ago
  • 1.2.0                                ...           3 years ago
  • 1.1.9                                ...           3 years ago
  • 1.1.8                                ...           3 years ago
  • 1.1.7                                ...           3 years ago
  • 1.1.6                                ...           3 years ago
  • 1.1.5                                ...           3 years ago
  • 1.1.4                                ...           3 years ago
  • 1.1.3                                ...           3 years ago
  • 1.1.2                                ...           3 years ago
  • 1.1.1                                ...           3 years ago
  • 1.1.0                                ...           3 years ago
  • 1.0.0                                ...           3 years ago
  • 0.0.1                                ...           3 years ago
Maintainers (2)
Downloads
Today 0
This Week 0
This Month 1
Last Day 0
Last Week 1
Last Month 5
Dev Dependencies (0)
None
Dependents (2)

Copyright 2014 - 2017 © taobao.org |