cisagov / skeleton-generic

A generic skeleton project for quickly getting a new cisagov project started.
Creative Commons Zero v1.0 Universal
13 stars 11 forks source link

Use new `markdownlint` rules for emphasis- and strong-styles #100

Closed mcdonnnj closed 2 years ago

mcdonnnj commented 2 years ago

🗣 Description

This pull request adds rules for MD049 and MD050, which were made available in 0.31.0 of our markdownlint hook. It also fixes the comment header for another rule in the same configuration.

💭 Motivation and context

Now that these rules are available we should enforce a specific style. I have chosen to use asterisks (*) due to general consensus about support. Per the CommonMark specification:

Many implementations have also restricted intraword emphasis to the * forms, to avoid unwanted emphasis in words containing internal underscores. (It is best practice to put these in code spans, but users often do not.)

🧪 Testing

Automated tests pass.

✅ Pre-approval checklist