Skip to content
This repository was archived by the owner on Jul 28, 2024. It is now read-only.

Use markdownlint for Markdown files #1348

Merged
borekb merged 3 commits into from
Aug 28, 2018
Merged

Use markdownlint for Markdown files #1348

borekb merged 3 commits into from
Aug 28, 2018

Conversation

@borekb
Copy link
Member

@borekb borekb commented Aug 27, 2018

This PR introduces markdownlint to the project:

  • New npm run lint:markdown script.
  • Pre-commit hook that runs the linter on staged files only (thanks to Husky and lint-staged).
  • All markdownlint violations fixed (there were only a couple).

@borekb borekb self-assigned this Aug 27, 2018
@borekb borekb added this to the 4.0 milestone Aug 27, 2018
@borekb borekb added scope: dev-infrastructure Build scripts, IDE settings, CI, Docker dev stack, testing, tooling, etc. scope: docs Markdown documentation, public docs, READMEs labels Aug 27, 2018
@borekb
Copy link
Member Author

borekb commented Aug 28, 2018 •
edited
Loading

I've got issues running this on Windows, may be related to Husky, will investigate later this week. It was some temporary problem, the pre-commit hook actually works fine.

@borekb borekb merged commit f25e6f0 into master Aug 28, 2018
@borekb borekb deleted the markdownlint branch August 28, 2018 20:49
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

No reviews

Assignees

@borekb borekb

Labels

scope: dev-infrastructure Build scripts, IDE settings, CI, Docker dev stack, testing, tooling, etc. scope: docs Markdown documentation, public docs, READMEs

Projects

None yet

Milestone

4.0

Development

Successfully merging this pull request may close these issues.

2 participants

@borekb