0

Context

While trying to preserve the formatting of a specific piece of output in a README.md file, I noticed I was not able to find an explanation on how to ignore a rule in the documentation. (Neither for the command line arguments, nor for the .pre-commit-config.yml.) Hence I would like to ask:

Question

How does one ignore rule:MD013 for mdformat in a .pre-commit-config.yml file?

Ideally, I would be able to include a comment inside the README.md file that tells mdformat to ignore rule MD013 for the next line, or next block of lines. Similar to:

# pylint: disable=R09013

Pre-commit config

The relevant piece of the .pre-commit-config.yml is:

# Enforces formatting style in Markdown (.md) files.
 - repo: https://github.com/executablebooks/mdformat
   rev: 0.7.14
   hooks:
   - id: mdformat
     #args: ["-r ~MD013"]
     additional_dependencies:
     - mdformat-toc
     - mdformat-gfm
     - mdformat-black
a.t.
  • 2,002
  • 3
  • 26
  • 66

0 Answers0