C2LC-303: Add markdown linting.

Metadata

Source
C2LC-303
Type
Sub-task
Priority
N/A
Status
Done
Resolution
N/A
Assignee
N/A
Reporter
Created
2021-02-05T04:20:19.920-0500
Updated
2021-10-28T10:33:41.095-0400
Versions
N/A
Fixed Versions
  1. Coding Env 1.0
Component
N/A

Description

As discussed in group chats, in working on C2LC-302 I am doing more markdown editing than we generally do. I think it would be helpful to add rudimentary linting for markdown files. My idea is to:

  1. Use the library markdownlint we use in other projects via npx (so that it is not actually a new dependency).
  2. Configure it to match our most commonly used style at the moment.
  3. Fix any current linting errors.
  4. Add the markdown linting to the end of our CI builds.