Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

please mdlinter in README.md #681

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

bastelfreak
Copy link
Member

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

this fixes:
`MD001 Header levels should only increment by one level at a time`
@bastelfreak bastelfreak added the docs Improvements or additions to documentation label Apr 19, 2020
@bastelfreak bastelfreak self-assigned this Apr 19, 2020
@bastelfreak
Copy link
Member Author

it passes 🤔

@baurmatt
Copy link
Contributor

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

@bastelfreak
Copy link
Member Author

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 :(

@baurmatt
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants