mdformat_admon 1.0.1

An mdformat plugin for admonitions.

mdformat-admon

An mdformat plugin for admonitions.

Usage

Add this package wherever you use mdformat and the plugin will be auto-recognized. No additional configuration necessary. See additional information on mdformat plugins here

Pre-commit

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

pipx

pipx install mdformat
pipx inject mdformat mdformat-admon

Caveats

This plugin currently only supports admonitions that start with !!! ... and won't modify admonitions for Github, which should cover most use cases. Future work is planned for other types.

See the example test file: ./tests/pre-commit-test.md

As a quick summary:

• python-markdown: is fully supported by mdformat-admon and tested extensively in ./tests/fixtures.md
• MKdocs: Is fully supported
• Unsupported, but won't modify:
  • Github: Unsupported and will not modify
  • MyST: Unsupported and will not modify
  • Remark-Admonitions: Unsupported and will not modify
• mdformat will break admonitions by:
  • reStructuredText: Unsupported and will break by removing or modifying indentation
  • Obsidian Callouts: Unsupported and will break because mdformat adds extra characters

Contributing

See CONTRIBUTING.md