Skip to main content

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.

Release files for mdformat-shfmt 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mdformat-shfmt 0.2.0
File Size Uploaded
mdformat_shfmt-0.2.0.tar.gz 2.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for mdformat-shfmt 0.2.0
File Interpreter ABI Platform
mdformat_shfmt-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 6.1 kB

Release files / mdformat_shfmt-0.2.0.tar.gz

Download URL mdformat_shfmt-0.2.0.tar.gz
Size 2.8 kB
Tags Source
SHA-256 checksum
How to use checksums
0c0f662b4f11a3fb1d175cf629330b08057afe91cdc259682bc8e856fcdf0b7a
BLAKE2b-256 checksum
How to use checksums
ed94ba4551aa5e3dc6bf7858dc628e0d56dfba5c669206c09e1be098095ad3bb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.4 CPython/3.12.7 Linux/6.5.0-1025-azure

Release files / mdformat_shfmt-0.2.0-py3-none-any.whl

Download URL mdformat_shfmt-0.2.0-py3-none-any.whl
Size 3.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
61ae5f25b6ad0dc39bb64928663254efd357b7bf4a018f9b3e0c8c8c845f0e3b
BLAKE2b-256 checksum
How to use checksums
3b06322c62c2e5199e604fed22b048250fc9acf9bcdbee2f496f18895c9ff1c6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.8.4 CPython/3.12.7 Linux/6.5.0-1025-azure

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files

0.1.0

2 release files

0.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page