Overview

The automated pre-commit checks in GitHub shows the code is broken. This is because pre-commit.ci is running a newer version of mdformat-mkdocs than our developer local systems, which is why we don't see the error.

In the newer version, mdformat-mkdocs and mdformat-admon are both trying to format admonitions, and we should drop mdformat-admin since mdformat-mkdocs does it better.

Action Items

• update the .pre-commit-config.yaml to remove mdformat-admon and set a minimum version on mdformat-mkdocs

Resources/Instructions

• The error: Recent commits to main where the ones in Feb 3 have red x marks for failing pre-commit

  

• Why don't developer see the error locally? Individual developers may not see this error if they have an older version of mdformat-mkdocs hook installed. The way to update is pre-commit clean followed by pre-commit run. Setting the minimum version will cause the developer pre-commit install to update to the new version.

• Why choose mdformat-mkdocs over mdformat-admon? from mdformat-mkdocs readme