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 #190 https://github.com/jekyll/jekyll-sitemap/issues/190 but not included in that discussion.
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 https://github.com/jekyll/jekyll-sitemap/issues/190 but not included in that discussion.Thanks for making this pugin.