docs: add GitHub Pages deployment guide #155
Merged
+122
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
acrogenesis
changed the title
mhanberg
reviewed
Sep 17, 2025
guides/deploying-to-github-pages.md
Outdated
| url: "https://your-domain.tld" | ||
| ``` | ||
|
|
||
| For GitHub Pages sites served from `<user>.github.io/<repo>`, use the full Pages URL and optionally set `base_path: "/<repo>"` so links render correctly locally. |
There was a problem hiding this comment.
Maybe link to some GitHub docs about this behavior.
I'm not familiar with modern GitHub pages, so I personally can't tell if this step is optional or not
There was a problem hiding this comment.
that's instructions for when you use the free url that github gives you
|
Awesome job! I left some comments, apologies for the quantity 😅 |
mhanberg
reviewed
Sep 18, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Following #154 I
Tested by running