Skip to content

hidden-markdown-heading

HTML comment hides a Markdown heading

Why

A heading hidden from rendered documentation is disabled documentation that silently drifts while version control already preserves removed sections.

Fix

Delete the hidden section, or restore it as maintained rendered documentation.

Examples

Before — flagged A hidden heading disables a documentation section
README.md
<!--
## Legacy setup
Use the retired command.
-->
After — preferred Current documentation stays rendered
README.md
## Setup
Run the current command.

Files

**/*.md**/*.mdx