This pre-commit hook allows you to run remark on git actions. For example autoformat and lint markdown files on each commit.
For pre-commit: see https://github.com/pre-commit/pre-commit
For remark-lint: see https://github.com/remarkjs/remark-lint
Add this to your .pre-commit-config.yaml
:
- repo: https://github.com/MaratFM/pre-commit-remark
rev: '' # Use the sha or tag you want to point at
hooks:
- id: remark
args: ['--output', '--frail'] # list of args for remark
additional_dependencies: ['remark-cli@8.0.1', 'remark-preset-lint-recommended@4.0.1'] # use latest versions and add additional plugins here
--output
Will fix some of the issues and rewrite files.
--frail
Exit with 1 on warnings.
--rc-path=.remarkrc
Provide custom path to remarkrc file.