Add a pre-commit hook to format the Markdown files

carpentries-incubator / SDC-BIDS-dMRI

Introduction to dMRI

https://carpentries-incubator.github.io/SDC-BIDS-dMRI/

Other

22 stars 16 forks source link

Add a pre-commit hook to format the Markdown files #147

Open jhlegarreta opened 3 years ago

jhlegarreta commented 3 years ago

Adding a pre-commit hook that is able to ensure that the Markdown files have a consistent format and follow the carpentries style would be a great addition and would allow developers to concentrate on the contents rather than the formatting.

Best would be to use a carpentries-wide adopted/recommended tool and the same configuration file.

jhlegarreta commented 3 years ago

Cross-referencing https://github.com/carpentries-incubator/SDC-BIDS-dMRI/issues/85#issuecomment-808214056 and #143.

Not sure if markdownlint is able to actually apply the format to the files or else it just flags the non-conforming lines; prettier seems to do both jobs.