mdformat 0.1.1

CommonMark compliant Markdown formatter

mdformat

CommonMark compliant Markdown formatter

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 features/opinions of the formatter include:

• Strip trailing and leading whitespace
• Always use ATX style headings
• Consistent indentation for contents of block quotes and list items
• Reformat reference links as inline links
• Reformat indented code blocks as fenced code blocks
• Separate blocks with a single empty line (an exception being tight lists where the separator is a single newline character)
• End the file in a single newline character
• Use 1. as the ordered list marker if possible, also for noninitial list items

Mdformat by default will not change word wrapping. The rationale for this is to support techniques like One Sentence Per Line and Semantic Line Breaks.

NOTE: The formatting style produced by mdformat may change in each version. It is recommended to pin mdformat dependency version.

Installing

pip install mdformat

Command line usage

Format files

Format files README.md and CHANGELOG.md in place

mdformat README.md CHANGELOG.md

Format .md files in current working directory recursively

mdformat .

Read Markdown from standard input until EOF. Write formatted Markdown to standard output.

mdformat -

Check formatting

mdformat --check README.md CHANGELOG.md

This will not apply any changes to the files. If a file is not properly formatted, the exit code will be non-zero.

Python API usage

Format text

import mdformat

unformatted = "\n\n# A header\n\n"
formatted = mdformat.text(unformatted)
assert formatted == "# A header\n"

Format a file

Format file README.md in place:

import mdformat

# Input filepath as a string...
mdformat.file("README.md")

# ...or a pathlib.Path object
import pathlib
filepath = pathlib.Path("README.md")
mdformat.file(filepath)

Usage as a pre-commit hook

mdformat can be used as a pre-commit hook. Add the following to your project's .pre-commit-config.yaml to enable this:

- repo: https://github.com/hukkinj1/mdformat
  rev: 0.1.1  # Use the ref you want to point at
  hooks:
  - id: mdformat