MDWrap

• Overview
• Pre-commit Hook
• Installation
• Usage
  • Arguments
• Limitations
• Alternatives
• Contributing
  • Development
  • Testing
  • Linting
  • Releasing
• References

mdwrap is a Python package that wraps text in Markdown files to a specified width. It also implements basic newline formatting and trailing whitespace removal. This package was built for compatibility with Material for MKDocs.

The motivation for this project was to have a lightweight package with no external dependencies that works well with Material for MkDocs for wrapping and basic formatting of Markdown files.

You can use mdwrap as a pre-commit hook to automatically wrap your Markdown files. To do so, add the following to your .pre-commit-config.yaml:

repos:
  - repo: https://github.com/csia-pme/mdwrap
      rev: 0.2.2
      hooks:
        - id: mdwrap
          args: [--print-width, "80", --fmt]

pip install git+https://github.com/csia-pme/[email protected]

mdwrap [-h] [--print-width PRINT_WIDTH] [--fmt] [--unwrap] [--check]
       [--ignore IGNORE] [--ignore-extend IGNORE_EXTEND] [--version]
       targets [targets ...]

# To format (wrap) a file:
mdwrap file.md
# To format (wrap + remove trailing newline + whitespace) a file:
mdwrap --fmt file.md
# To check (wrap) a file:
mdwrap --check file.md
# To check (wrap + remove trailing newline + whitespace) a file:
mdwrap --fmt --check file.md

One limitation of mdwrap is that it does not yet support wrapping quote blocks.

• mdformat is a Python package that formats Markdown files. It is more feature-rich than mdwrap however it does not support Material for MkDocs admonitions entirely.
• prettier is a powerful code formatter that supports Markdown. It's only downside is that it needs a node environment to run.

Create and enable a virtual environment:

python -m venv .venv
source .venv/bin/activate

Install the development dependencies:

pip install .

Install the pre-commit hooks:

pre-commit install

To run the tests:

pytest

To lint the code:

pre-commit run -a

1. Make sure to first update the versions in this file.
2. Update the CHANGELOG.
3. Next, release a new version by running the following:

# Bump the version in pyproject.toml
sed -i 's/version = ".*"/version = "0.x.y"/' pyproject.toml
# Create a new tag
git tag <version> main
# Push the tag
git push origin <version>

4. Update the changes in the new GitHub release.
5. Finally, update the version in the pre-commit hook in .pre-commit-config.yaml.

This project is built with the following tools:

• pre-commit
• pytest
• flake8
• black

It is also inspired by the following projects:

• black
• prettier