Skip to main content

Mdformat plugin to format shell code blocks

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mdformat_shfmt-0.2.0.tar.gz (2.8 kB view details)

Uploaded Source

Built Distribution

mdformat_shfmt-0.2.0-py3-none-any.whl (3.3 kB view details)

Uploaded Python 3

File details

Details for the file mdformat_shfmt-0.2.0.tar.gz.

File metadata

  • Download URL: mdformat_shfmt-0.2.0.tar.gz
  • Upload date:
  • Size: 2.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.5.0-1025-azure

File hashes

Hashes for mdformat_shfmt-0.2.0.tar.gz
Algorithm Hash digest
SHA256 0c0f662b4f11a3fb1d175cf629330b08057afe91cdc259682bc8e856fcdf0b7a
MD5 8e82a0e01445d009517c81c7a0c249ec
BLAKE2b-256 ed94ba4551aa5e3dc6bf7858dc628e0d56dfba5c669206c09e1be098095ad3bb

See more details on using hashes here.

File details

Details for the file mdformat_shfmt-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: mdformat_shfmt-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 3.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.5.0-1025-azure

File hashes

Hashes for mdformat_shfmt-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 61ae5f25b6ad0dc39bb64928663254efd357b7bf4a018f9b3e0c8c8c845f0e3b
MD5 8da6d10aed339cc4026415f61b95da12
BLAKE2b-256 3b06322c62c2e5199e604fed22b048250fc9acf9bcdbee2f496f18895c9ff1c6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page