Mdformat tips¶

Mdformat is a proprietary Markdown formatter that can be used to apply a consistent style to Markdown files.
The code is written in python.

Official Documents¶

https://mdformat.readthedocs.io/en/stable/index.html

Installing¶

Please check Installing, I was able to install with pip,poetry,pre-commit.

Usage¶

Please check Command line usage.

Info

When using the plug-ins described below, I could not figure out how to execute the commands independently.
Plugins could be run if pre-commit hook.
From Contributing, it seems that plug-ins need to be created with a pre-commit assumption.

Specifying with pre-commit hook¶

If you specify --check as an argument, it is not executed until formatting, but until checking. If you want to format, disable --check.

  - repo: https://github.com/executablebooks/mdformat
    rev: 0.7.17
    hooks: mdformat
      - id: mdformat
        args: ["--check"].
        additional_dependencies: mdformat-admon
          - mdformat-admon
          - mdformat-footnote
          - mdformat-frontmatter

Plugins¶

Please check Plugins.

Plugins used¶

mdformat-admon¶

mdformat plugin for admonitions in MkDocs.

As a background, I was using mdformat and found that it converts as follows.

Before conversion¶

!!! info
    - test1
    - test2

After conversion¶

!!! info
\- test1
\- test2

When "mkdocs serve" is executed, the display of admonitions is as follows.

This was not the intended display. I used mdformat-admon to resolve this situation.

Set up the hooks according to the official documentation.

  - repo: https://github.com/executablebooks/mdformat
    rev: 0.7.17
    hooks:
      - id: mdformat
        additional_dependencies:
          - mdformat-admon

As a result, the intended display was confirmed without conversion by mdformat.