diff --git a/docs/ja/config/README.md b/docs/ja/config/README.md new file mode 100644 index 0000000000..1fc6b33c52 --- /dev/null +++ b/docs/ja/config/README.md @@ -0,0 +1,448 @@ +--- +sidebar: auto +--- + +# Configuration Reference + +## Global CLI Config + +Some global configurations for `@vue/cli`, such as your preferred package manager and your locally saved presets, are stored in a JSON file named `.vuerc` in your home directory. You can edit this file directly with your editor of choice to change the saved options. + +You can also use the `vue config` command to inspect or modify the global CLI config. + +## Target Browsers + +See the [Browser Compatibility](../guide/browser-compatibility.md#browserslist) section in guide. + +## vue.config.js + +`vue.config.js` is an optional config file that will be automatically loaded by `@vue/cli-service` if it's present in your project root (next to `package.json`). You can also use the `vue` field in `package.json`, but do note in that case you will be limited to JSON-compatible values only. + +The file should export an object containing options: + +``` js +// vue.config.js +module.exports = { + // options... +} +``` + +### baseUrl + +Deprecated since Vue CLI 3.3, please use [`publicPath`](#publicPath) instead. + +### publicPath + +- Type: `string` +- Default: `'/'` + + The base URL your application bundle will be deployed at (known as `baseUrl` before Vue CLI 3.3). This is the equivalent of webpack's `output.publicPath`, but Vue CLI also needs this value for other purposes, so you should **always use `publicPath` instead of modifying webpack `output.publicPath`**. + + By default, Vue CLI assumes your app will be deployed at the root of a domain, e.g. `https://www.my-app.com/`. If your app is deployed at a sub-path, you will need to specify that sub-path using this option. For example, if your app is deployed at `https://www.foobar.com/my-app/`, set `publicPath` to `'/my-app/'`. + + The value can also be set to an empty string (`''`) or a relative path (`./`) so that all assets are linked using relative paths. This allows the built bundle to be deployed under any public path, or used in a file system based environment like a Cordova hybrid app. + + ::: warning Limitations of relative publicPath + Relative `publicPath` has some limitations and should be avoided when: + + - You are using HTML5 `history.pushState` routing; + + - You are using the `pages` option to build a multi-paged app. + ::: + + This value is also respected during development. If you want your dev server to be served at root instead, you can use a conditional value: + + ``` js + module.exports = { + publicPath: process.env.NODE_ENV === 'production' + ? '/production-sub-path/' + : '/' + } + ``` + +### outputDir + +- Type: `string` +- Default: `'dist'` + + The directory where the production build files will be generated in when running `vue-cli-service build`. Note the target directory will be removed before building (this behavior can be disabled by passing `--no-clean` when building). + + ::: tip + Always use `outputDir` instead of modifying webpack `output.path`. + ::: + +### assetsDir + +- Type: `string` +- Default: `''` + + A directory (relative to `outputDir`) to nest generated static assets (js, css, img, fonts) under. + + ::: tip + `assetsDir` is ignored when overwriting the filename or chunkFilename from the generated assets. + ::: + +### indexPath + +- Type: `string` +- Default: `'index.html'` + + Specify the output path for the generated `index.html` (relative to `outputDir`). Can also be an absolute path. + +### filenameHashing + +- Type: `boolean` +- Default: `true` + + By default, generated static assets contains hashes in their filenames for better caching control. However, this requires the index HTML to be auto-generated by Vue CLI. If you cannot make use of the index HTML generated by Vue CLI, you can disable filename hashing by setting this option to `false`. + +### pages + +- Type: `Object` +- Default: `undefined` + + Build the app in multi-page mode. Each "page" should have a corresponding JavaScript entry file. The value should be an object where the key is the name of the entry, and the value is either: + + - An object that specifies its `entry`, `template`, `filename`, `title` and `chunks` (all optional except `entry`). Any other properties added beside those will also be passed directly to `html-webpack-plugin`, allowing user to customize said plugin; + - Or a string specifying its `entry`. + + ``` js + module.exports = { + pages: { + index: { + // entry for the page + entry: 'src/index/main.js', + // the source template + template: 'public/index.html', + // output as dist/index.html + filename: 'index.html', + // when using title option, + // template title tag needs to be