carpentries-incubator / carpentries-incubator/python-intermediate-development
Configure a markdown linter for editing our lesson source files
- Dominant language
- TeX
- Stars
- 63
- Forks
- 77
- Avg merge
- 20h 8m
- Merged PRs (30d)
- 3
Description
This was mentioned in #437 which I think was prematurely closed. The formatting / linting of markdown files across our lesson contain many inconsistencies, and often leads to me getting sidetracked fixing things that should be enforced by a linter/formatter. `markdownlint` seems like the tool for the job, so I will draft up a config file that enforces The Carpentries Workbench Style and makes editing easier for us.
Contributor guide
Research direction
Start by reviewing issue #437 and the lesson source Markdown files, then compare markdownlint with the Carpentries Workbench Style. Done means a markdownlint configuration exists that enforces the agreed formatting consistently across the lesson sources and supports easier editing.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 64/100