diff --git a/README.md b/README.md index 65b131e..4a8d006 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,7 @@

- Preview + Preview
Shadow @@ -76,16 +76,18 @@ There are two ways to use **GitProfile**. Use either one. These instructions will get you a copy of the project and deploy your portfolio online! - **Fork repo:** Click [here](https://github.com/arifszn/gitprofile/fork) to fork the repo so you have your own project to customize. A "fork" is a copy of a repository. -- **Rename repo:** Rename your forked repository to `username.github.io` in GitHub, where `username` is your GitHub username (or organization name). +- **Rename repo:** + - If you want to host your portfolio at `https://.github.io`, rename your forked repository to `username.github.io` in GitHub, where `username` is your GitHub username (or organization name). + - If you want to host your portfolio at `https://.github.io/` (e.g. `https://.github.io/portfolio`), rename your forked repository to `` (e.g. `portfolio`) in GitHub. - **Enable workflows:** Go to your repo's **Actions** page and enable workflows. ![Workflows](https://arifszn.github.io/assets/img/hosted/gitprofile/workflows.png) - **Base Value:** Open `vite.config.js`, and change `base`'s value. - - If you are deploying to `https://.github.io/`, set `base` to `'/'`. + - If you are deploying to `https://.github.io`, set `base` to `'/'`. - - If you are deploying to `https://.github.io//`, for example your repository is at `https://github.com//`, then set `base` to `'//'`. + - If you are deploying to `https://.github.io/` (e.g. `https://.github.io/portfolio`), then set `base` to `'//'` (e.g. `'/portfolio/'`). ```js // vite.config.js @@ -98,9 +100,9 @@ These instructions will get you a copy of the project and deploy your portfolio - **First Commit:** Now commit to your **main** branch with your changes. The CI/CD pipeline will publish your page at the `gh-pages` branch automatically. - **Change deploy branch:** Go to your repo's **Settings** ➜ **Pages** ➜ **Source** and change the branch to `gh-pages` and click **save**. -Your personal portfolio will be live at `username.github.io`. Any time you commit a change to the **main** branch, the website will be automatically updated. +Your portfolio website will be live by now. Any time you commit a change to the **main** branch, the website will be automatically updated. -If you see only `README` at `username.github.io`, be sure to change your GitHub Page's source to `gh-pages` branch. See [how to](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site). Also, if you face any issue rendering the website, double-check the `base` value in the `vite.config.js`. +If you see only `README` at your website, be sure to change your GitHub Page's source to `gh-pages` branch (see [how to](https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)). Also, if you face any issue rendering the website, double-check the `base` value in the `vite.config.js`. As this is a vite project, you can also host your website to Netlify, Vercel, Heroku, or other popular services. Please refer to this [doc](https://vitejs.dev/guide/static-deploy.html) for a detailed deployment guide to other services.