Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README.md how to base URL for pre-built deployment #286

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

README.md how to base URL for pre-built deployment #286

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1328bef
README.md how to base URL for pre-built deployment
DylanLawless Jun 30, 2021
3366786
Update README.md
DylanLawless Jun 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,12 @@ defaults:
1. `script/bootstrap`
2. `script/cibuild`

## Base URL for pre-built deployment
For some Jekyll users, since plugins cannot be run on GitHub pages, they opt to build locally and push their pre-built
`_site` from the _source branch_ instead of `_root` on the _master branch_.
In this case, to build the sitemap using the base url defined in `_config.yml` instead of "local host",
you will first need to `build` rather than `serve` before pushing `_site` to Github; `bundle exec jekyll build`

## Known Issues

1. If the `sitemap.xml` doesn't generate in the `_site` folder, ensure `_config.yml` doesn't have `safe: true`. That prevents all plugins from working.
Expand Down