puppet-zabbix icon indicating copy to clipboard operation
puppet-zabbix copied to clipboard

please mdlinter in README.md

Open bastelfreak opened this issue 5 years ago • 4 comments

this fixes: MD001 Header levels should only increment by one level at a time

Pull Request (PR) description

This Pull Request (PR) fixes the following issues

bastelfreak avatar Apr 19 '20 21:04 bastelfreak

it passes :thinking:

bastelfreak avatar Apr 19 '20 21:04 bastelfreak

Should we modulesync a matching Travis job for this? We use the following internally in our Gitlab-CI:

markdown-lint:
  stage: test
  image: node:alpine
  before_script:
    - npm install -g markdownlint markdownlint-cli
  script: find . -type f -name "*\.md" -print0 | xargs -0 markdownlint

baurmatt avatar Apr 20 '20 08:04 baurmatt

in general I would like to have this. I'm using https://rubygems.org/gems/mdl at the moment. The issue is that none of our README.md passes, so enforcing this in a CI pipeline is tricky :(

bastelfreak avatar Apr 20 '20 19:04 bastelfreak

@bastelfreak Can we just trigger a warning instead of a error? This might gradually fix it.

baurmatt avatar Apr 21 '20 07:04 baurmatt