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 or Docker installed is a requirement.

Installing

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

Usage

mdformat YOUR_MARKDOWN_FILE.md

Limitations

Formatting with Docker is not tested on Windows. If you experience issues on Windows, 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.1.0.tar.gz (3.2 kB view hashes)

Uploaded source

Built Distribution

mdformat_shfmt-0.1.0-py3-none-any.whl (3.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page