index.rst

How to format markdown files

The markdown files are all formatted according to a consistent style using mdformat.

How to install mdformat

To install mdformat run:

$ python -m pip install mdformat

How to format all markdown files

To run mdformat on a specific <file>:

$ python -m mdformat <file>

This will reformat <file> in place.

To run mdformat recursively from the current directory:

$ python -m mdformat .

How to check markdown files

To check the format of <file>:

$ python -m mdformat --check <file>