mdformat_mkdocs 1.0.2

An mdformat plugin for mkdocs.

mdformat-mkdocs

An mdformat plugin for mkdocs.

Usage

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

Tip: this package specifies an "extra" ('recommended') for plugins that work well with mkdocs:

• mdformat-admon
• mdformat-beautysh
• mdformat-black
• mdformat-config
• mdformat-footnote
• mdformat-frontmatter
• mdformat-simple-breaks
• mdformat-tables
• mdformat-toc
• mdformat-web

Pre-commit

repos:
  - repo: https://github.com/executablebooks/mdformat
    rev: 0.7.16
    hooks:
      - id: mdformat
        additional_dependencies:
          - mdformat-mkdocs
          # Or
          # - "mdformat-mkdocs[recommended]"

pipx

pipx install mdformat
pipx inject mdformat mdformat-mkdocs
# Or
# pipx inject mdformat "mdformat-mkdocs[recommended]"

CLI Options

mdformat-mkdocs adds the CLI argument --align-semantic-breaks-in-numbered-lists to optionally align line breaks in numbered lists to 3-spaces. If not specified, the default of 4-indents is followed universally.

# with: mdformat
1. Semantic line feed where the following line is
    three spaces deep

# vs. with: mdformat --align-semantic-breaks-in-numbered-lists
1. Semantic line feed where the following line is
   three spaces deep

Note: the align-semantic-breaks-in-numbered-lists setting is not supported in the configuration file yet (https://github.com/executablebooks/mdformat/issues/378)

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