Skip to content

Latest commit

 

History

History
26 lines (21 loc) · 1.13 KB

README.md

File metadata and controls

26 lines (21 loc) · 1.13 KB
Raw

Build Status PyPI version

mdformat-shfmt

Mdformat plugin to format shell code blocks

Description

mdformat-shfmt is an mdformat plugin that makes mdformat format shell code blocks embedded in Markdown with shfmt. The plugin invokes shfmt in a subprocess so having either shfmt, Docker or Podman installed is a requirement.

Installing

  1. Install either shfmt, Docker or Podman
  2. Install mdformat-shfmt 
    pip install mdformat-shfmt

Usage

mdformat YOUR_MARKDOWN_FILE.md

Limitations

The Docker/Podman fallback is only tested on Linux. If you experience issues with it on Windows or macOS, please install shfmt.