Use inline HTML for heading tags, not Gitiles MD; allow <a> HTML element #831
Conversation
This file contains 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
dfarrell07
requested review from
mkolesnik,
Oats87,
skitt,
sridhargaddam and
tpantelis
as code owners
|
🤖 Created branch: z_pr831/dfarrell07/commonmark_headings |
✅ Deploy Preview for elated-bell-2913d9 ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
dfarrell07
force-pushed
the
commonmark_headings
branch
from
5bc1e73
to
8e12c05
Compare
dfarrell07
changed the title
dfarrell07
force-pushed
the
commonmark_headings
branch
from
8e12c05
to
cdd75e2
Compare
This was referenced Oct 6, 2022
tpantelis
approved these changes
Oct 7, 2022
nyechiel
approved these changes
Oct 8, 2022
sridhargaddam
approved these changes
Oct 9, 2022
The MD linter follows CommonMark, and in CommonMark the only way to add custom ID tags to headings is by using HTML <a id="short-id"></a>. Other syntaxes are valid in some MD syntaxes, but not CommonMark. Signed-off-by: Daniel Farrell <dfarrell@redhat.com>
This syntax for creating ID tags for headings (typically with complex names) isn't supported in CommonMark, which is the standard used by our MD linter. It's valid syntax in Gitiles MD, which is why the links work. Upstream feature request to add support for this type of header ID: DavidAnson/markdownlint#570 This is required for submariner-io#827. Signed-off-by: Daniel Farrell <dfarrell@redhat.com>
sridhargaddam
force-pushed
the
commonmark_headings
branch
from
cdd75e2
to
a6a7783
Compare
|
🤖 Closed branches: [z_pr831/dfarrell07/commonmark_headings] |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
See commit messages for details