From 906b9bc99240f5cfb2a0dd7cda87f5ec165054e8 Mon Sep 17 00:00:00 2001 From: Solomon Hykes Date: Mon, 14 Jun 2021 16:11:37 +0000 Subject: [PATCH] Contributing FAQ: how to run markdown linter manually Signed-off-by: Solomon Hykes --- CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4ea30def..a8552237 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -84,3 +84,19 @@ Guidelines: change the last commit (amend) instead of creating a new commit. - Format: Use the imperative mood in the subject line: "If applied, this commit will _your subject line here_" + + +## FAQ + +### How to run the markdown linter locally + +First install `markdownlint-cli`: + +* On Mac OS: `brew install markdownlint-cli` +* On other systems, with yarn installed: `yarn global add markdownlint-cli` + +Then from the repository root: + +``` +markdownlint -c .markdownlint.yaml docs/**/*.md +```