Skip to content

New Rule: no-emphasis-as-heading #683

Description

@FloEdelmann

Rule details

Prevent emphasized (i.e. bold or italic) text used to separate sections, where a heading should be used instead

What type of rule is this?

Warns about a potential problem

Example code

Bad:

**My document**

Lorem ipsum dolor sit amet...

_Another section_

Consectetur adipiscing elit, sed do eiusmod.

Good:

# My document

Lorem ipsum dolor sit amet...

## Another section

Consectetur adipiscing elit, sed do eiusmod.

Prior Art

Markdownlint rule MD036 (no-emphasis-as-heading): https://github.com/DavidAnson/markdownlint/blob/main/doc/md036.md

Participation

  • I am willing to submit a pull request to implement this rule.

AI acknowledgment

  • I did not use AI to generate this issue report.
  • (If the above is not checked) I have reviewed the AI-generated content before submitting.

Additional comments

No response

Metadata

Metadata

Assignees

Type

No type

Projects

Status
Ready to Implement

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions