Update README to clarify project site configuration requirements with tools like CRA, webpack, Vite, etc. #445
+12
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've noticed a common misconception about GitHub Pages, specifically project sites that are not served at the root
<user|org>.github.io
domain and instead under a/<repo>
path.Some example issues for the
gh-pages
project that reflect this:The only way I can think to alleviate this is to address it right in the project's
README.md
, hence this PR.