Skip to content

Commit 2ad1873

Browse files
📖 Fix typo in GitHub Pages documentation (#2550)
Co-authored-by: Stefan van der Walt <[email protected]>
1 parent 2e6e81f commit 2ad1873

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/deployment-github-pages.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ This has activated GitHub Pages to accept new HTML from GitHub actions.
3030
To trigger the action, push new commits of code to the branch that you've configured with the action above. You should start seeing your website show up at `<githuborg>.github.io/<githubrepo>`.
3131

3232
## `BASE_URL` Configuration for GitHub Pages
33-
The MyST CLI needs to know the destination (base URL) or your site during build time. If you setup deployment to GitHub Pages using the `myst init --gh-pages` command, then _this is handled automatically for you_. Otherwise, if you deploy your website from a repository that's not the default GitHub Pages repository (i.e., not called `<username>.github.io`), you likely need to define a `BASE_URL` that includes the repository name.[^except-custom-domains]
33+
The MyST CLI needs to know the destination (base URL) of your site during build time. If you setup deployment to GitHub Pages using the `myst init --gh-pages` command, then _this is handled automatically for you_. Otherwise, if you deploy your website from a repository that's not the default GitHub Pages repository (i.e., not called `<username>.github.io`), you likely need to define a `BASE_URL` that includes the repository name.[^except-custom-domains]
3434
[^except-custom-domains]: If you're using a custom domain, you may not need to set `BASE_URL` if the site is served from the base domain (e.g.: `mydomain.org`) without a sub-folder (e.g., `mydomain.org/mydocs/`).
3535

3636
## Example: A Full GitHub Action

0 commit comments

Comments
 (0)