Update site template configuration file with link to config options docs #563
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.
This is a 🙋 feature or enhancement.
Summary
This commit adds a link to the configuration options docs directly into the default
bridgetown.config.yml
. This will make navigating to the docs quicker and will also increase discoverability of those options for folks getting started with Bridgetown.Context
I often need to reference the configuration options docs when updating my site config. Typically, I have to navigate to the Bridgetown site, and then search/find the link for the configuration options, which takes several clicks and can break my concentration. This change will also ensure that the options are easily discoverable in case someone has trouble finding them on the website.
Not a necessity, but it would be nice to have and provide a smoother DX after running
bridgetown new
.