diff --git a/README.md b/README.md index 641b7bf233..bab263012b 100644 --- a/README.md +++ b/README.md @@ -43,10 +43,10 @@ python3 -m http.server 9000 --directory public ## Test the docs locally -To ensure all python snippets are properly formatted before creating a PR, install [flake8-markdown](https://github.com/johnfraney/flake8-markdown) and add the following like to `.git/hooks/pre-commit`: +To ensure all python snippets are properly formatted before creating a commit, install [flake8-markdown](https://github.com/johnfraney/flake8-markdown) and add the following like to `.git/hooks/pre-commit`: ```sh -flake8-markdown "docs/**/*.md" +flake8-markdown $(git diff --diff-filter=d --name-only HEAD | grep '\.md$') ``` To ensure your markdown is properly formatted, run `make markdowntest`.