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

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.0.0.tar.gz (3.1 kB view hashes)

Uploaded Source

Built Distribution

mdformat_shfmt-0.0.0-py3-none-any.whl (3.1 kB view hashes)

Uploaded Python 3

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