Skip to content

Latest commit

 

History

History
40 lines (24 loc) · 921 Bytes

File metadata and controls

40 lines (24 loc) · 921 Bytes

Ensuring consistent markdown format with mdformat

From the mdformat's documentation page:

"Mdformat is an opinionated Markdown formatter that can be used to enforce a consistent style in Markdown files. Mdformat is a Unix-style command-line tool as well as a Python library."

The rationale for using mdformat is the same as the one for using black <black-discussion> which is to avoid spending any time thinking about the formatting of source files.

Examples of choices that mdformat will make:

# Hello world

Here is how to write some python code:

   print("Hello Nashpy!)

become:

# Hello world

Here is how to write some python code:

```
print("Hello Nashpy!)
```