indicate use of baseurl configuration for Github Pages deployment #57
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.
I have been learning Jekyll and Just the Docs recently, thank you for this very helpful template. Based on my experience customizing Just the Docs, my intention with this PR is to bring the Just the Docs README and default configuration closer to the approach recommended by Jekyll.
If I understand Jekyll correctly, when a site is going to be served from a subfolder, the
baseurl
parameter should be set in_config.yml
. Jekyll resources often specifically name a Github Pages deployment as an example of a situation when baseurl should be used.So if I have a github repo named
cushaw-handbook
that I am deploying via Github Pages, I believe that the correct Jekyll configuration would include:In my situation this is relevant to image processing and styling. With
baseurl
set, I can now use functionality Jekyll'srelative_url
function in my content:Thank you for considering this patch.