From 545e64af9785613a62d24eafa43baea5c397f0a4 Mon Sep 17 00:00:00 2001 From: Naomi Pentrel <5212232+npentrel@users.noreply.github.com> Date: Thu, 14 Sep 2023 20:17:46 -0400 Subject: [PATCH] test --- .pre-commit-config.yaml | 6 ------ README.md | 6 +++++- 2 files changed, 5 insertions(+), 7 deletions(-) delete mode 100644 .pre-commit-config.yaml diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml deleted file mode 100644 index e7b56bc2c6..0000000000 --- a/.pre-commit-config.yaml +++ /dev/null @@ -1,6 +0,0 @@ -# .pre-commit-config.yaml -repos: - - repo: https://github.com/johnfraney/flake8-markdown - rev: v0.5.0 - hooks: - - id: flake8-markdown diff --git a/README.md b/README.md index 7bfaabb726..641b7bf233 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,11 @@ python3 -m http.server 9000 --directory public ## Test the docs locally -To ensure all python snippets are properly formatted before creating a PR, create a [pre-commit hook](https://github.com/johnfraney/flake8-markdown#pre-commit-hook) for [flake8-markdown](https://github.com/johnfraney/flake8-markdown). +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`: + +```sh +flake8-markdown "docs/**/*.md" +``` To ensure your markdown is properly formatted, run `make markdowntest`.