You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: readme.md
+12Lines changed: 12 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -355,6 +355,18 @@ And then to publish everything from your `dist` folder to your `gh-pages` branch
355
355
npm run deploy
356
356
```
357
357
358
+
##GitHub Pages Project Sites
359
+
360
+
There are three types of GitHub Pages sites:[project, user, and organization](https://docs.github.com/en/pages/getting-started-with-github-pages/about-github-pages#types-of-github-pages-sites). Since project sites are not hosted on the root`<user|org>.github.io` domain and instead under a URL path based on the repository name, they often require configuration tweaks for various build tools and frameworks. If not configured properly, a browser will usually log`net::ERR_ABORTED 404` errors when looking for compiled assets.
361
+
362
+
Examples:
363
+
- Create React App (which uses webpack under the hood)[requires the user to set a`"homepage"` property in their`package.json` so that built assets are referenced correctly in the final compiled HTML](https://create-react-app.dev/docs/deployment/#building-for-relative-paths).
364
+
- This[has been often been thought of as an issue with`gh-pages`](https://github.com/tschaub/gh-pages/issues/285#issuecomment-805321474), though this package isn't able to control a project's build configuration.
365
+
- Vite[requires a`"base"` property in its`vite.config.js`](https://vitejs.dev/guide/static-deploy.html#github-pages)
366
+
- Next.js does not support deploying to GitHub Pages[because of an opinionated static export approach that puts all assets under a`_next` direcotry that GitHub Pages ignores](https://github.com/vercel/next.js/issues/9460).
367
+
368
+
When using a project site, be sure to read the documentation for your particular build tool or framework to learn how to configure correct asset paths.
369
+
358
370
##Debugging
359
371
360
372
To get additional output from the`gh-pages` script, set`NODE_DEBUG=gh-pages`. For example: