docs: wip

carlosrojaso · Jun 5, 2018 · 4e92205 · 4e92205
1 parent a81f7ad
commit 4e92205
Show file tree

Hide file tree

Showing 31 changed files with 1,550 additions and 906 deletions.
diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js
@@ -0,0 +1,93 @@
+module.exports = {
+  locales: {
+    '/': {
+      lang: 'en-US',
+      title: 'Vue CLI',
+      description: 'Standard Tooling for Vue.js Projects'
+    }
+  },
+  serviceWorker: true,
+  theme: 'vue',
+  themeConfig: {
+    repo: 'vuejs/vue-cli',
+    docsDir: 'docs',
+    docsBranch: 'dev',
+    editLinks: true,
+    sidebarDepth: 3,
+    locales: {
+      '/': {
+        label: 'English',
+        selectText: 'Languages',
+        lastUpdated: 'Last Updated',
+        editLinkText: 'Edit this page on GitHub',
+        nav: [
+          {
+            text: 'Guide',
+            link: '/guide/'
+          },
+          {
+            text: 'Config Reference',
+            link: '/config/'
+          },
+          {
+            text: 'Dev Guide',
+            items: [
+              { text: 'Plugin Dev Guide', link: '/dev-guide/plugin-dev.md' },
+              { text: 'UI Plugin Dev Guide', link: '/dev-guide/ui-plugin-dev.md' },
+              { text: 'UI Localization', link: '/dev-guide/ui-localization.md' }
+            ]
+          },
+          {
+            text: 'Plugins',
+            items: [
+              { text: 'Babel', link: 'https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-babel' },
+              { text: 'Typescript', link: 'https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-typescript' },
+              { text: 'ESLint', link: 'https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-eslint' },
+              { text: 'PWA', link: 'https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-pwa' },
+              { text: 'Jest', link: 'https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-unit-jest' },
+              { text: 'Mocha', link: 'https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-unit-mocha' },
+              { text: 'Cypress', link: 'https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-e2e-cypress' },
+              { text: 'Nightwatch', link: 'https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-e2e-nightwatch' }
+            ]
+          },
+          {
+            text: 'Changelog',
+            link: 'https://github.com/vuejs/vue-cli/blob/dev/CHANGELOG.md'
+          }
+        ],
+        sidebar: {
+          '/guide/': [
+            '/guide/',
+            {
+              title: 'CLI',
+              collapsable: false,
+              children: [
+                '/guide/creating-a-project',
+                '/guide/plugins-and-presets',
+                '/guide/prototyping',
+                '/guide/ui'
+              ]
+            },
+            {
+              title: 'Development',
+              collapsable: false,
+              children: [
+                '/guide/cli-service',
+                '/guide/browser-compatibility',
+                '/guide/html-and-static-assets',
+                '/guide/mode-and-env',
+                '/guide/build-targets',
+                '/guide/deployment'
+              ]
+            }
+          ],
+          '/dev-guide/': [
+            '/dev-guide/plugin-dev.md',
+            '/dev-guide/ui-plugin-dev.md',
+            '/dev-guide/ui-localization.md'
+          ]
+        }
+      }
+    }
+  }
+}
diff --git a/docs/config-ui.png → docs/.vuepress/public/config-ui.png b/docs/config-ui.png → docs/.vuepress/public/config-ui.png
diff --git a/docs/custom-view.png → docs/.vuepress/public/custom-view.png b/docs/custom-view.png → docs/.vuepress/public/custom-view.png
diff --git a/docs/plugin-search-item.png → docs/.vuepress/public/plugin-search-item.png b/docs/plugin-search-item.png → docs/.vuepress/public/plugin-search-item.png
diff --git a/docs/plugins.png → docs/.vuepress/public/plugins.png b/docs/plugins.png → docs/.vuepress/public/plugins.png
diff --git a/docs/screenshot.png → docs/.vuepress/public/screenshot.png b/docs/screenshot.png → docs/.vuepress/public/screenshot.png
diff --git a/docs/task-view.png → docs/.vuepress/public/task-view.png b/docs/task-view.png → docs/.vuepress/public/task-view.png
diff --git a/docs/tasks-ui.png → docs/.vuepress/public/tasks-ui.png b/docs/tasks-ui.png → docs/.vuepress/public/tasks-ui.png
diff --git a/docs/vue-cli-ui-preview.gif → docs/.vuepress/public/vue-cli-ui-preview.gif b/docs/vue-cli-ui-preview.gif → docs/.vuepress/public/vue-cli-ui-preview.gif
diff --git a/docs/vue-cli-ui-schema.png → docs/.vuepress/public/vue-cli-ui-schema.png b/docs/vue-cli-ui-schema.png → docs/.vuepress/public/vue-cli-ui-schema.png
diff --git a/docs/README.md b/docs/README.md
@@ -1,25 +1,4 @@
-## Table of Contents
-
-- [Introduction](#introduction)
-- [CLI](#cli)
-- [CLI Service](#cli-service)
-- [Conventions](#conventions)
-  - [The Index Page](#the-index-page)
-  - [Static Assets Handling](#static-assets-handling)
-  - [Environment Variables and Modes](#environment-variables-and-modes)
-- [Configuration](#configuration)
-  - [webpack](#webpack)
-  - [browserslist](#browserslist)
-  - [Dev Server Proxy](#dev-server-proxy)
-  - [Babel](#babel)
-  - [CSS](#css)
-  - [ESLint](#eslint)
-  - [TypeScript](#typescript)
-  - [Unit Testing](#unit-testing)
-  - [E2E Testing](#e2e-testing)
-- [Development](#development)
-
-## Introduction
+# Introduction
 
 Vue CLI is a full system for rapid Vue.js development, providing:
 
@@ -34,132 +13,18 @@ Vue CLI is a full system for rapid Vue.js development, providing:
 
 Vue CLI aims to be the standard tooling baseline for the Vue ecosystem. It ensures the various build tools work smoothly together with sensible defaults so you can focus on writing your app instead of spending days wrangling with configurations. At the same time, it still offers the flexibility to tweak the config of each tool without the need for ejecting.
 
-## CLI
-
-The CLI is installed globally and provides the `vue` command in your terminal:
-
-``` sh
-npm install -g @vue/cli
-vue create my-project
-```
-
-See [CLI docs](./cli.md) for all available commands.
-
-## CLI Service
-
-`@vue/cli-service` is a dependency installed locally into every project created by `@vue/cli`. It contains the core service that loads other plugins, resolves the final webpack config, and provides the `vue-cli-service` binary to your project. If you are familiar with [create-react-app](https://github.com/facebookincubator/create-react-app), `@vue/cli-service` is essentially the equivalent of `react-scripts`, but more flexible.
-
-See [CLI Service docs](./cli-service.md) for all available commands.
-
-## Conventions
-
-### The Index Page
-
-The file `public/index.html` is a template that will be processed with [html-webpack-plugin](https://github.com/jantimon/html-webpack-plugin). During build, asset links will be injected automatically. In addition, Vue CLI also automatically injects resource hints (`preload/prefetch`), manifest/icon links (when PWA plugin is used) and inlines the webpack runtime / chunk manifest for optimal performance.
-
-### Static Assets Handling
-
-Static assets can be handled in two different ways:
-
-- Imported in JavaScript or referenced in templates/CSS via relative paths. Such references will be handled by webpack.
-
-- Placed in the `public` directory and referenced via absolute paths. These assets will simply be copied and not go through webpack.
-
-See [Static Assets Handling](./assets.md) for more details.
-
-### Environment Variables and Modes
-
-It is a common need to customize the app's behavior based on the target environment - for example, you may want the app to use different API endpoints or credentials during development / staging / production environments.
-
-Vue CLI has comprehensive support for specifying different environment variables using modes and `.env` files.
-
-See [Environment Variables and Modes](./env.md) for more details.
-
-## Configuration
-
-Projects created from `vue create` are ready to go out-of-the-box. The plugins are designed to work with one another so in most cases, all you need to do is pick the features you want during the interactive prompts.
-
-However, we also understand that it's impossible to cater to every possible need, and the need of a project may also change over time. Projects created by Vue CLI allows you to configure almost every aspect of the tooling without ever needing to eject.
-
-### vue.config.js
-
-Many aspects of a Vue CLI project can be configured by placing a `vue.config.js` file at the root of your project. The file may already exist depending on the features you selected when creating the project.
-
-`vue.config.js` should export an object, for example:
-
-``` js
-// vue.config.js
-module.exports = {
-  lintOnSave: true
-}
-```
-
-Check [here](./config.md) for full list of possible options.
-
-### webpack
-
-Probably the most common configuration need is tweaking the internal webpack config. Vue CLI provides flexible ways to achieve that without ejecting.
-
-See [here](./webpack.md) for full details.
-
-### browserslist
-
-You will notice a `browserslist` field in `package.json` specifying a range of browsers the project is targeting. This value will be used by `babel-preset-env` and `autoprefixer` to automatically determine the JavaScript polyfills and CSS vendor prefixes needed.
-
-See [here](https://github.com/ai/browserslist) for how to specify browser ranges.
-
-### Dev Server Proxy
-
-If your frontend app and the backend API server are not running on the same host, you will need to proxy API requests to the API server during development. This is configurable via the `devServer.proxy` option in `vue.config.js`.
-
-See [Configuring Proxy](./cli-service.md#configuring-proxy) for more details.
-
-### Babel
-
-Babel can be configured via `.babelrc` or the `babel` field in `package.json`.
-
-All Vue CLI apps use `@vue/babel-preset-app`, which includes `babel-preset-env`, JSX support and optimized configuration for minimal bundle size overhead. See [its docs](https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/babel-preset-app) for details and preset options.
-
-### CSS
-
-Vue CLI projects comes with support for [PostCSS](http://postcss.org/), [CSS Modules](https://github.com/css-modules/css-modules) and pre-processors including [Sass](https://sass-lang.com/), [Less](http://lesscss.org/) and [Stylus](http://stylus-lang.com/).
-
-See [here](./css.md) for more details on CSS related configurations.
-
-### ESLint
-
-ESLint can be configured via `.eslintrc` or `eslintConfig` field in `package.json`.
-
-See [@vue/cli-plugin-eslint](https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-eslint) for more details.
-
-### TypeScript
-
-TypeScript can be configured via `tsconfig.json`.
-
-See [@vue/cli-plugin-typescript](https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-typescript) for more details.
-
-### Unit Testing
-
-- #### Jest
-
-  See [@vue/cli-plugin-unit-jest](https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-unit-jest) for more details.
-
-- #### Mocha (via `mocha-webpack`)
-
-  See [@vue/cli-plugin-unit-mocha](https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-unit-mocha) for more details.
-
-### E2E Testing
-
-- #### Cypress
-
-  See [@vue/cli-plugin-e2e-cypress](https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-e2e-cypress) for more details.
-
-- #### Nightwatch
-
-  See [@vue/cli-plugin-e2e-nightwatch](https://github.com/vuejs/vue-cli/tree/dev/packages/%40vue/cli-plugin-e2e-nightwatch) for more details.
-
-## Development
-
-- [Contributing Guide](https://github.com/vuejs/vue-cli/blob/dev/.github/CONTRIBUTING.md)
-- [Plugin Development Guide](https://github.com/vuejs/vue-cli/blob/dev/docs/plugin-dev.md)
-- [Plugin UI Development Guide](https://github.com/vuejs/vue-cli/blob/dev/docs/plugin-dev-ui.md)
+- Overview
+- CLI
+  - Creating a Project
+  - Plugins and Presets
+  - Instant Prototyping
+  - CLI UI
+- Development
+  - The CLI Service
+  - Browser Compatibility
+  - HTML and static assets
+  - Mode and Environment Variables
+  - Git Hooks
+  - Building as a Library
+  - Building as Web Components
+  - Deployment
diff --git a/docs/config.md b/docs/config.md