Markdown Lint Buildkite Plugin
Checks Markdown files and flags style issues.
Have you ever updated your README or other important documentation, to discover later that it doesn't render the way you expected?
Has your team codified its Markdown style guide for a project using
Does Buildkite already perform checks on your repository?
This plugin is for you!
This plugin was developed following Buildkite's Writing Plugins guide. It will be useful on some projects at work but I wrote it in my own time and haven't had a chance to try it at work yet. Perhaps check the pulse to see if it's used.
To run the tests locally:
Add the following to your
steps: - label: ":markdown: Markdown Lint" plugins: - johnsyweb/markdownlint#v1.0.0: pattern: '*.md'
pattern (optional, string)
The file name pattern, for example
*.markdown. Supports any pattern
supported by find -name.
version (optional, string)
Version of markdownlint image to use.
markdownlint-buildkite-plugin uses MIT license. See
Code of Conduct
We welcome contribution from everyone. Read more about it in
For bug fixes, documentation changes, and features:
- Fork it
- Create your feature branch (
git switch -c my-new-feature)
- Commit your changes (
git commit -am 'Add some feature')
- Run the tests (
- Push to the branch (
git push origin my-new-feature)
- Create a new Pull Request
For larger new features: Do everything as above, but first also make contact with the project maintainers to be sure your change fits with the project direction and you won't be wasting effort going in the wrong direction.