Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add markdownlint for documentation formatting consistency #3367

Merged
merged 1 commit into from
Aug 22, 2022

Conversation

bmish
Copy link
Contributor

@bmish bmish commented Aug 21, 2022

Add popular tool markdownlint-cli which runs markdownlint via a package.json script for documentation formatting consistency and best practices.

The vast majority of these changes were autofixed.

Summary of the main changes:

  • Each file should have only one top-level header
  • Header sizes should decrement one level at a time
  • No consecutive blank lines
  • All code fences should specify their language
  • Lists should use the same type of bullet point

There's a good markdownlint VSCode extension which highlights and autofixes these issues as well: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint

package.json Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Aug 21, 2022

Codecov Report

Merging #3367 (ae34341) into master (11306e1) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #3367   +/-   ##
=======================================
  Coverage   97.54%   97.54%           
=======================================
  Files         123      123           
  Lines        8873     8873           
  Branches     3244     3244           
=======================================
  Hits         8655     8655           
  Misses        218      218           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

README.md Outdated Show resolved Hide resolved
docs/rules/boolean-prop-naming.md Show resolved Hide resolved
docs/rules/iframe-missing-sandbox.md Show resolved Hide resolved
docs/rules/jsx-fragments.md Show resolved Hide resolved
docs/rules/require-optimization.md Outdated Show resolved Hide resolved
docs/rules/static-property-placement.md Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
package.json Show resolved Hide resolved
@bmish bmish force-pushed the markdownlint branch 3 times, most recently from 456fab3 to 04b4db1 Compare August 21, 2022 21:11
docs/rules/static-property-placement.md Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
package.json Show resolved Hide resolved
Copy link
Member

@ljharb ljharb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for bearing with me!

@ljharb ljharb merged commit ae34341 into jsx-eslint:master Aug 22, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants