Skip to content

Commit

Permalink
Add markdown prefix to the js file and explanatory comment
Browse files Browse the repository at this point in the history
  • Loading branch information
grego952 committed Mar 21, 2024
1 parent a811f6e commit a7d7db7
Showing 1 changed file with 2 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
// This file is used to trigger the custom rule that checks if all markdown headings (words longer than 4 characters) are written in the title case. To run this check, you must include the check in the markdownlint command.
// For example, if you want to run the check on the `docs` folder, run the following command: `markdownlint -r ./markdown_heading_capitalization.js docs/`.
module.exports = [{
"names": [ "custom/capitalize-headings" ],
"description": "Heading words longer than 4 characters should be capitalized",
Expand Down

0 comments on commit a7d7db7

Please sign in to comment.