mdformat-mkdocs 0.0.1

An mdformat plugin for mkdocs.

mdformat-mkdocs

An mdformat plugin for mkdocs.

Warning

This is an initial proof of concept. Non-list items nested within a list are not properly handled (i.e. nested code blocks, quotes, etc.). Please open an issue and share examples that aren't properly supported!

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-mkdocs

pipx

pipx install mdformat
pipx inject mdformat mdformat-mkdocs

Caveats

• All indents are converted to 4-spaces
• This plugin converts all bulleted items to dashes and numerals to 1.

See the example test files, ./tests/pre-commit-test.md and ./tests/fixtures.md

Contributing

See CONTRIBUTING.md