https://github.com/hukkin/mdformat-shfmt
Mdformat plugin to format shell code blocks
https://github.com/hukkin/mdformat-shfmt
bash markdown mdformat shfmt
Last synced: 6 months ago
JSON representation
Mdformat plugin to format shell code blocks
- Host: GitHub
- URL: https://github.com/hukkin/mdformat-shfmt
- Owner: hukkin
- License: mit
- Created: 2021-01-25T18:06:24.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-01-08T12:30:33.000Z (9 months ago)
- Last Synced: 2025-04-09T10:08:06.248Z (6 months ago)
- Topics: bash, markdown, mdformat, shfmt
- Language: Python
- Homepage:
- Size: 39.1 KB
- Stars: 17
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[]()
[![PyPI version]()]()
# mdformat-shfmt
> Mdformat plugin to format shell code blocks
## Description
mdformat-shfmt is an [mdformat](https://github.com/executablebooks/mdformat) plugin
that makes mdformat format shell code blocks embedded in Markdown with [shfmt](https://github.com/mvdan/sh).
The plugin invokes shfmt in a subprocess so having either shfmt, Docker or Podman installed is a requirement.
## Installing
1. Install either [shfmt](https://github.com/mvdan/sh#shfmt), [Docker](https://docs.docker.com/get-docker/) or [Podman](https://podman.io/docs/installation)
1. Install mdformat-shfmt
```bash
pip install mdformat-shfmt
```
## Usage
```bash
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.