docs: move to VuePress (vuejs#627)

Author: eddyerburgh

.circleci/config.yml

@@ -17,6 +17,9 @@ jobs:
     steps:
       - checkout
       - *restore_node_modules
+      - run:
+          name: remove vuepress from dependencies
+          command: sed -i '/vuepress/ d' package.json
       - run:
           name: yarn --version
           command: yarn --version

docs/.vuepress/_redirects

@@ -0,0 +1,26 @@
+/en/*  /:splat
+
+/api/mount /api/#mount
+/api/shallowMount /api/#shallowmount
+/api/createLocalVue /api/#createlocalvue
+/api/config /api/#config
+
+/api/wrapper/*  /api/wrapper.html/#:splat
+/api/wrapper-array/*  /api/wrapper-array.html/#:splat
+
+/ja/api/mount /ja/api/#mount
+/ja/api/shallowMount /ja/api/#shallowmount
+/ja/api/createLocalVue /ja/api/#createlocalvue
+/ja/api/config /ja/api/#config
+
+/ja/api/wrapper/* /ja/api/wrapper.html/#:splat
+/ja/api/wrapper/* /ja/api/wrapper.html/#:splat
+/ja/api/wrapper-array/*  /ja/api/wrapper-array.html/#:splat
+
+/zh/api/mount /zh/api/#mount
+/zh/api/shallowMount /zh/api/#shallowmount
+/zh/api/createLocalVue /zh/api/#createlocalvue
+/zh/api/config /zh/api/#config
+
+/zh/api/wrapper/* /zh/api/wrapper.html/#:splat
+/zh/api/wrapper-array/*  /zh/api/wrapper-array.html/#:splat

docs/.vuepress/config.js

@@ -0,0 +1,105 @@
+module.exports = {
+  locales: {
+    '/': {
+      lang: 'en-US',
+      title: 'Vue Test Utils',
+      description: 'Utilities for testing Vue components'
+    },
+    '/ja/': {
+      lang: 'ja',
+      title: 'Vue Test Utils',
+      description: 'Vue コンポーネントをテストするためのユーティリティ'
+    },
+    '/zh/': {
+      lang: 'zh-CN',
+      title: 'Vue Test Utils',
+      description: '测试 Vue 组件的实用工具'
+    }
+  },
+  serviceWorker: true,
+  theme: 'vue',
+  themeConfig: {
+    repo: 'vuejs/vue-test-utils',
+    docsDir: 'docs',
+    locales: {
+      '/': {
+        label: 'English',
+        selectText: 'Languages',
+        editLinkText: 'Edit this page on GitHub',
+        nav: [
+          {
+            text: 'API',
+            link: '/api/'
+          },
+          {
+            text: 'Guides',
+            link: '/guides/'
+          }
+        ],
+        sidebar: [
+          '/',
+          '/guides/',
+          '/api/',
+          '/api/wrapper/',
+          '/api/wrapper-array/',
+          '/api/options',
+          '/api/components/'
+        ]
+      },
+      '/zh/': {
+        label: '简体中文',
+        selectText: '选择语言',
+        editLinkText: '在 GitHub 上编辑此页',
+        nav: [
+          {
+            text: 'API',
+            link: '/zh/api/'
+          },
+          {
+            text: '教程',
+            link: '/zh/guides/'
+          }
+        ],
+        sidebar: [
+          '/zh/',
+          '/zh/guides/',
+          '/zh/api/',
+          '/zh/api/wrapper/',
+          '/zh/api/wrapper-array/',
+          '/zh/api/options',
+          '/zh/api/components/'
+        ]
+      },
+      '/ja/': {
+        label: '日本語',
+        selectText: '言語',
+        editLinkText: 'GitHub 上でこのページを編集する',
+        nav: [
+          {
+            text: 'API',
+            link: '/ja/api/'
+          },
+          {
+            text: 'ガイド',
+            link: '/ja/guides/'
+          }
+        ],
+        sidebar: [
+          '/ja/',
+          '/ja/guides/',
+          '/ja/api/',
+          '/ja/api/wrapper/',
+          '/ja/api/wrapper-array/',
+          '/ja/api/options',
+          '/ja/api/components/'
+        ]
+      }
+    }
+  },
+  markdown: {
+    config: md => {
+      // use more markdown-it plugins!
+      md.use(require('markdown-it-include'))
+    }
+  }
+}

docs/LANGS.md

@@ -1,11 +1,9 @@
-# Vue Test Utils
+# Introduction
 
 Vue Test Utils is the official unit testing utility library for Vue.js.
 
-## Table of Contents
-
-* [Guides](guides/README.md)
-  * [Getting Started](guides/getting-started.md)
+* [Guides](./guides/README.md)
+  * [Getting Started](./guides/getting-started.md)
   * [Common Tips](guides/common-tips.md)
   * [Mouse, Key and other DOM Events](guides/dom-events.md)
   * [Choosing a test runner](guides/choosing-a-test-runner.md)

docs/en/README.md renamed to docs/README.md

@@ -0,0 +1,9 @@
+# API
+
+!!!include(docs/api/mount.md)!!!
+!!!include(docs/api/shallowMount.md)!!!
+!!!include(docs/api/render.md)!!!
+!!!include(docs/api/renderToString.md)!!!
+!!!include(docs/api/selectors.md)!!!
+!!!include(docs/api/createLocalVue.md)!!!
+!!!include(docs/api/config.md)!!!

docs/api/README.md

@@ -0,0 +1,7 @@
+# Components
+
+Vue Test Utils includes utility components you can use to stub components.
+
+!!!include(docs/api/components/RouterLinkStub.md)!!!
+!!!include(docs/api/components/TransitionStub.md)!!!
+!!!include(docs/api/components/TransitionGroupStub.md)!!!

docs/api/components/README.md

@@ -1,4 +1,4 @@
-# `RouterLinkStub`
+## RouterLinkStub
 
 A component to stub the Vue Router `router-link` component.
 

docs/en/api/components/RouterLinkStub.md renamed to docs/api/components/RouterLinkStub.md

@@ -1,4 +1,4 @@
-# `TransitionGroupStub`
+## TransitionGroupStub
 
 A component to stub the `transition-group` component. Instead of performing transitions asynchronously, it returns the child components synchronously.
 
@@ -28,4 +28,4 @@ mount(Component, {
     'transition-group': TransitionGroupStub
   }
 })
-```
+```

docs/en/api/components/TransitionGroupStub.md renamed to docs/api/components/TransitionGroupStub.md

@@ -1,4 +1,4 @@
-# `TransitionStub`
+## TransitionStub
 
 A component to stub the `transition` component. Instead of performing transitions asynchronously, it returns the child component synchronously.
 

docs/en/api/components/TransitionStub.md renamed to docs/api/components/TransitionStub.md

@@ -1,8 +1,8 @@
-# Config
+## Config
 
 Vue Test Utils includes a config object to defined options used by Vue Test Utils.
 
-## Vue Test Utils Config Options
+### Vue Test Utils Config Options
 
 ### `stubs`
 

docs/en/api/config.md renamed to docs/api/config.md

@@ -1,4 +1,4 @@
-# `createLocalVue()`
+## createLocalVue()
 
 - **Returns:**
   - `{Component}`

docs/en/api/createLocalVue.md renamed to docs/api/createLocalVue.md

@@ -1,4 +1,4 @@
-# `mount(component [, options])`
+## mount()
 
 - **Arguments:**
 

docs/en/api/mount.md renamed to docs/api/mount.md

@@ -2,8 +2,6 @@
 
 Options for `mount` and `shallowMount`. The options object can contain both Vue Test Utils mounting options and other options.
 
-## Vue Test Utils Specific Mounting Options
-
 - [`context`](#context)
 - [`slots`](#slots)
 - [`scopedSlots`](#scopedslots)
@@ -16,7 +14,7 @@ Options for `mount` and `shallowMount`. The options object can contain both Vue
 - [`provide`](#provide)
 - [`sync`](#sync)
 
-### `context`
+## context
 
 - type: `Object`
 
@@ -38,7 +36,7 @@ const wrapper = mount(Component, {
 expect(wrapper.is(Component)).toBe(true)
 ```
 
-### `slots`
+## slots
 
 - type: `{ [name: string]: Array<Component>|Component|string }`
 
@@ -61,15 +59,15 @@ const wrapper = shallowMount(Component, {
 expect(wrapper.find('div')).toBe(true)
 ```
 
-#### Passing text
+### Passing text
 
 You can pass text to `slots`.  
 There is a limitation to this.
 
 This does not support PhantomJS.  
 You can use [Puppeteer](https://github.com/karma-runner/karma-chrome-launcher#headless-chromium-with-puppeteer) as an alternative.
 
-### `scopedSlots`
+## scopedSlots
 
 - type: `{ [name: string]: string }`
 
@@ -95,7 +93,7 @@ const wrapper = shallowMount(Component, {
 expect(wrapper.find('#fooWrapper').html()).toBe('<div id="fooWrapper"><p>0,text1</p><p>1,text2</p><p>2,text3</p></div>')
 ```
 
-### `stubs`
+## stubs
 
 - type: `{ [name: string]: Component | boolean } | Array<string>`
 
@@ -120,7 +118,7 @@ shallowMount(Component, {
 })
 ```
 
-### `mocks`
+## mocks
 
 - type: `Object`
 
@@ -138,7 +136,7 @@ const wrapper = shallowMount(Component, {
 expect(wrapper.vm.$route.path).toBe($route.path)
 ```
 
-### `localVue`
+## localVue
 
 - type: `Vue`
 
@@ -169,32 +167,32 @@ const wrapper = mount(Component, {
 expect(wrapper.vm.$route).toBeInstanceOf(Object)
 ```
 
-### `attachToDocument`
+## attachToDocument
 
 - type: `boolean`
 - default: `false`
 
 Component will be attached to DOM when rendered if set to `true`.
 
-### `attrs`
+## attrs
 
 - type: `Object`
 
 Set the component instance's `$attrs` object.
 
-### `listeners`
+## listeners
 
 - type: `Object`
 
 Set the component instance's `$listeners` object.
 
-### `provide`
+## provide
 
 - type: `Object`
 
 Pass properties for components to use in injection. See [provide/inject](https://vuejs.org/v2/api/#provide-inject).
 
-### `sync`
+## sync
 
 - type: `boolean`
 - default: `true`

docs/en/api/options.md renamed to docs/api/options.md

@@ -1,4 +1,4 @@
-# `render(component [, options])`
+## render()
 
 - **Arguments:**
 

docs/en/api/render.md renamed to docs/api/render.md

@@ -1,4 +1,4 @@
-# `renderToString(component [, options])`
+## renderToString()
 
 - **Arguments:**
 

docs/en/api/renderToString.md renamed to docs/api/renderToString.md

@@ -1,8 +1,8 @@
-# Selectors
+## Selectors
 
 A lot of methods take a selector as an argument. A selector can either be a CSS selector, a Vue component, or a find option object.
 
-## CSS Selectors
+### CSS Selectors
 
 Mount handles any valid CSS selector:
 
@@ -19,7 +19,7 @@ You can also use combinators:
 - adjacent sibling selector (`div + .foo`)
 - general sibling selector (`div ~ .foo`)
 
-## Vue Components
+###Vue Components
 
 Vue components are also valid selectors.
 
@@ -39,9 +39,9 @@ const wrapper = shallowMount(Foo)
 expect(wrapper.is(Foo)).toBe(true)
 ```
 
-## Find Option Object
+###Find Option Object
 
-### Name
+#### Name
 
 Using a find option object, Vue Test Utils allows for selecting elements by a `name` of component on wrapper components.
 
@@ -50,7 +50,7 @@ const buttonWrapper = wrapper.find({ name: 'my-button' })
 buttonWrapper.trigger('click')
 ```
 
-### Ref
+#### Ref
 
 Using a find option object, Vue Test Utils allows for selecting elements by `$ref` on wrapper components.