diff --git a/README.md b/README.md index 04feab693a3f28b23c52855169cd7332380e5da7..5e563f72cd2349f621cc860a4c2e893b6945e85c 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,13 @@ project's **Settings**. Read more about [user/group Pages][userpages] and [project Pages][projpages]. +## Project name +You'll need to set the correct base in docs/.vuepress/config.js. + +If you are deploying to https://<USERNAME or GROUP>.gitlab.io/, you can omit base as it defaults to "/". + +If you are deploying to https://<USERNAME or GROUP>.gitlab.io/<REPO>/, (i.e. your repository is at https://gitlab.com/<USERNAME>/<REPO>), set base to "/<REPO>/". + ## Did you fork this project? If you forked this project for your own use, please go to your project's