README.md how to base URL for pre-built deployment #286
Conversation
This file contains 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
Since GitHub Pages blocks plugins (like Jekyll-scholar), many Jekyll users pre-build their site before deploying to GitHub Pages. This is most commonly done using `bundle exec jekyll serve` on the _source branch_. However, this will fail to use the correct URL defined in the _config.yml and instead use "http://localhost". A two sentence description is added to `README.md` to show the required usage, which will prevent people from creating an invalid sitemap, or giving up if they notice their incorrect URL despite correct `_config.yml` settings. Similar to issue jekyll#190 jekyll#190 but not included in that discussion. Thanks for making this pugin.
Correction to pull request for REAME.md example usage on line 86: `bundle exec jekyll build & `bundle exec jekyll serve` to `bundle exec jekyll build`. `serve` should not be run after `build` to produce the correct sitemap URL for pre-built deployment.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Since GitHub Pages blocks plugins (like Jekyll-scholar), many Jekyll users pre-build their site before deploying to GitHub Pages. This is most commonly done using
bundle exec jekyll serveon the source branch. However, this will fail to use the correct URL defined in the _config.yml and instead use "http://localhost".A two sentence description is added to
README.mdto show the required usage, which will prevent people from creating an invalid sitemap, or giving up if they notice their incorrect URL despite correct_config.ymlsettings. Similar to issue #190 #190 but not included in that discussion.Thanks for making this pugin.