docs: harmonize markdown docs with prettier linting

[MikeMcC399]

Status

Markdown documents in this repo are not currently linted. This includes JavaScript code blocks inside Markdown README.md and docs/rules/*.md documents.

Change

• Protect generated section in README.md from formatting conflicts between Prettier and eslint-doc-generator:

  <!-- prettier-ignore-start -->
  <!-- prettier-ignore-end -->
  

• Lint Markdown files with npm run format whilst temporarily allowing Prettier formatting of *.md files and update them accordingly

Verification

On Ubuntu 24.04.2 LTS, Node.js 22.16.0 LTS

npm install eslint-doc-generator -g
eslint-doc-generator

Confirm no files are changed

Other

• Do not test on Windows or enable permanent Prettier linting for Markdown at this time. See eslint-doc-generator may produce incorrect results on Windows #265 for current status.
• .prettierignore continues to contain **/*.md

[cypress-app-bot]

• Create a Draft Pull Request if your PR is not ready for review. Mark the PR as Ready for Review when you're ready for a Cypress team member to review the PR.

[jennifer-shehane]

🎉 This PR is included in version 5.1.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀