Skip to content
Prev Previous commit
Next Next commit
docs: update deployment.md for github custom domains (#6239)
Adding information about omitting publicpath config if you deploy to a custom domain.
  • Loading branch information
anzuj authored Jan 27, 2021
commit 89f88efe543583f7d0e51ef5cd6e46fa434bae27
2 changes: 1 addition & 1 deletion docs/guide/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ If you are using the PWA plugin, your app must be served over HTTPS so that [Ser

1. Set correct `publicPath` in `vue.config.js`.

If you are deploying to `https://<USERNAME>.github.io/`, you can omit `publicPath` as it defaults to `"/"`.
If you are deploying to `https://<USERNAME>.github.io/` or to a custom domain, you can omit `publicPath` as it defaults to `"/"`.

If you are deploying to `https://<USERNAME>.github.io/<REPO>/`, (i.e. your repository is at `https://github.com/<USERNAME>/<REPO>`), set `publicPath` to `"/<REPO>/"`. For example, if your repo name is "my-project", your `vue.config.js` should look like this:

Expand Down