Fix sub section links for /docs/gatsby-config #9290
Merged
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.
Bug:
The links for configuration options on the Gatsby Config page don't scroll to the right section because they have incorrect id
URL in link: https://www.gatsbyjs.org/docs/gatsby-config/#pathPrefix
Actual link: https://www.gatsbyjs.org/docs/gatsby-config/#pathprefix
Notice the lowercased part at the end. The actual links are generated by gatsby-remark-autolink-headers.
Fix
In this pull request, I've changed the url in links to be lowercase as well. (This is what the react docs do as well)
Alternate Fix
The problem with this fix is that it's not consistent with the older version of the docs which use camelCased links. Example: https://www.gatsbyjs.org/docs/actions/#addThirdPartySchema
gatsby-remark-autolink-headers
usesgithub-slugger
to create the slugs for markdown headers - which supports camelCased slugs as well by passing an addition argument (test case: github-slugger/index#13)This will have to be opt-in option for
gatsby-remark-autolink-headers
so that applications already using it don't break.Let me know what you think