Skip to content

Commit

Permalink
Allow HTML <a> element in MD, support heading IDs
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
dfarrell07 authored and tpantelis committed Oct 9, 2022
1 parent 613b098 commit dd663fa
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions .markdownlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,10 @@ line-length:
line_length: 140

# Allow HTML span elements to set font sizes and for shortcodes
# Allow <a id="short-heading"></a> to support [Link](#short-heading)
no-inline-html:
allowed_elements:
- a
- code
- div
- li
Expand Down

0 comments on commit dd663fa

Please sign in to comment.