Use GitHub Pages site origin for setting up SSG configs #21
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.
From what I could tell, two (SvelteKit and Gatsby) of the currently supported static site generators have a configuration option for the URL of the deployed site. This allows for code to access the site URL during prerendering, which is useful for social sharing, meta tags, JSON-LD, and more. Since
configure-pages
does have knowledge of this URL, I think it makes sense to pass it to the SSG configurations.Let me know if this was already discussed and decided against. Also, the other generators might support a similar config option, and I would be happy to add them to this PR.
I got the name for Gatsby's config option from the docs. It's possible that users would want the
pathPrefix
also attached to thesiteUrl
, which is certainly possible. I didn't include it because it is accessible with library functions and in the previous tests with asiteURL
(this was the capitalization before), it didn't include thepathPrefix
.