Consider adding a linter into the build process
- Dominant language
- Shell
- Stars
- 31
- Forks
- 30
- Avg merge
- 5h 17m
- Merged PRs (30d)
- 2
Description
Add either https://github.com/markdownlint/markdownlint (ruby) or https://github.com/DavidAnson/markdownlint (node) into the CI build. The node one is copied from the ruby one but not sure which is the best or most active. Both would need configuration to according to our preferred style of .md and also to not barf on Hugo stuff like short codes or front matter.
Contributor guide
Research direction
Compare the Ruby and Node markdownlint options linked in the issue, starting with the repository's existing CI build configuration. Define the preferred Markdown rules and Hugo exceptions for shortcodes and front matter, then verify that the CI build lints the documentation without rejecting valid Hugo content.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- hugo, node.js, ruby
- Domain
- ci-cd, documentation, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100