sous-chefs / meta

Discussion about Sous Chefs
Creative Commons Attribution 4.0 International
3 stars 7 forks source link

Standardize Markdown rules between repositories #130

Closed PowerSchill closed 1 year ago

PowerSchill commented 4 years ago

:speaking_head: Foreword

Thank for taking the time to fill this feature request fully. Without it we may not be able to , and the issue may be closed without resolution.

:person_frowning: Problem Statement

Since we are enforcing markdown linting we should standardize the ruleset we apply to our repositories.

:grey_question: Possible Solution

Adding a .mdlrc file to each repository will apply a standardized set of rules for repositories.

:arrow_heading_up: Describe alternatives you've considered

:heavy_plus_sign: Additional context

Add any other context about the problem here. e.g. related issues or existing pull requests.

A base .mdlrc file that I have used is below. Let's start with this and update/extend.

# Only check rules for files known to git
git_recurce true

# Ignore line length
# Ignore multiple headings with the same content
rules "~MD013", "~MD024"