gchq / stroom-docs

Documentation for Stroom and associated projects
Apache License 2.0
30 stars 25 forks source link

Consider adding a linter into the build process #60

Open at055612 opened 3 years ago

at055612 commented 3 years ago

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.