Install
Prerequisites
Section titled “Prerequisites”- Python 3.12+
- Git
mddocslint has no runtime dependencies.
Installation steps
Section titled “Installation steps”-
Clone the repository in your desired directory:
git clone https://github.com/caseylee-TC/mddocslint.git -
Move into the cloned repository:
cd mddocslint -
Create a virtual environment. This keeps mddocslint separate from your other Python projects:
python -m venv .venv -
Activate the virtual environment:
-
PowerShell:
.venv\Scripts\Activate.ps1 -
Git Bash:
source .venv/Scripts/activate -
macOS and Linux:
source .venv/bin/activate
When the virtual environment is active, your prompt starts with
(.venv). You must activate it again in every new terminal before you usemddocslint. -
-
Install mddocslint:
python -m pip install . -
Check that it is installed:
mddocslint --helpIf you see the usage message, you are ready to go.
If your shell says it can’t find
mddocslint, the virtual environment is not active. Repeat step 4.
To update mddocslint later, run git pull and then python -m pip install . again. A regular install is a copy, so it does not pick up changes until you reinstall.
Next steps
Section titled “Next steps”- Run mddocslint on a docs folder.
- Set up the pre-commit hook to lint before each commit.