build: generate proper anchor ids for headings in markdown #19371
Conversation
This file contains hidden or 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
googlebot
added
the
cla: yes
devversion
force-pushed
the
build/generate-proper-anchors-markdown
branch
from
3881a75 to
037fb7a
Compare
devversion
added
merge safe
P3
josephperrott
approved these changes
May 15, 2020
Currently we compute the anchor ids for headings in guides and overviews manually. Our logic here does not match with the ids generated by Github, so one needs to either fix up all references to the anchor for the docs, but that will break the links in most markdown editors. We fix this by using the integrated `slugify` method provided by the `marked` package. This one seems to match the usual id generation in markdown files (as in Github and most markdown editors). This fixes links in the cdk-testing harness overview as observed originally in angular#19366.
devversion
force-pushed
the
build/generate-proper-anchors-markdown
branch
from
037fb7a to
58ee7b4
Compare
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Currently we compute the anchor ids for headings in guides and
overviews manually. Our logic here does not match with the ids generated
by Github, so one needs to either fix up all references to the anchor
for the docs, but that will break the links in most markdown editors.
We fix this by using the integrated
slugifymethod provided by themarkedpackage. This one seems to match the usual id generation inmarkdown files (as in Github and most markdown editors).
This fixes links in the cdk-testing harness overview as observed
originally in #19366.