{"id":16728760,"url":"https://github.com/hukkin/mdformat-shfmt","last_synced_at":"2025-04-10T11:07:24.123Z","repository":{"id":39887367,"uuid":"332837850","full_name":"hukkin/mdformat-shfmt","owner":"hukkin","description":"Mdformat plugin to format shell code blocks","archived":false,"fork":false,"pushed_at":"2025-01-08T12:30:33.000Z","size":40,"stargazers_count":17,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-09T10:08:06.248Z","etag":null,"topics":["bash","markdown","mdformat","shfmt"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hukkin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-25T18:06:24.000Z","updated_at":"2025-02-23T01:31:48.000Z","dependencies_parsed_at":"2025-02-17T02:44:01.728Z","dependency_job_id":null,"html_url":"https://github.com/hukkin/mdformat-shfmt","commit_stats":{"total_commits":6,"total_committers":2,"mean_commits":3.0,"dds":"0.16666666666666663","last_synced_commit":"cc0cbd989c199fd7d674521cb6bee6cf4baf24b5"},"previous_names":["hukkinj1/mdformat-shfmt"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hukkin%2Fmdformat-shfmt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hukkin%2Fmdformat-shfmt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hukkin%2Fmdformat-shfmt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hukkin%2Fmdformat-shfmt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hukkin","download_url":"https://codeload.github.com/hukkin/mdformat-shfmt/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248208067,"owners_count":21065199,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bash","markdown","mdformat","shfmt"],"created_at":"2024-10-12T23:11:38.415Z","updated_at":"2025-04-10T11:07:24.105Z","avatar_url":"https://github.com/hukkin.png","language":"Python","funding_links":[],"categories":["bash"],"sub_categories":[],"readme":"[![Build Status](https://github.com/hukkin/mdformat-shfmt/actions/workflows/tests.yaml/badge.svg?branch=master)](\u003chttps://github.com/hukkin/mdformat-shfmt/actions?query=workflow%3ATests+branch%3Amaster+event%3Apush\u003e)\n[![PyPI version](\u003chttps://img.shields.io/pypi/v/mdformat-shfmt\u003e)](\u003chttps://pypi.org/project/mdformat-shfmt\u003e)\n\n# mdformat-shfmt\n\u003e Mdformat plugin to format shell code blocks\n\n## Description\nmdformat-shfmt is an [mdformat](https://github.com/executablebooks/mdformat) plugin\nthat makes mdformat format shell code blocks embedded in Markdown with [shfmt](https://github.com/mvdan/sh).\nThe plugin invokes shfmt in a subprocess so having either shfmt, Docker or Podman installed is a requirement.\n\n## Installing\n1. Install either [shfmt](https://github.com/mvdan/sh#shfmt), [Docker](https://docs.docker.com/get-docker/) or [Podman](https://podman.io/docs/installation)\n1. Install mdformat-shfmt\n   ```bash\n   pip install mdformat-shfmt\n   ```\n\n## Usage\n```bash\nmdformat YOUR_MARKDOWN_FILE.md\n```\n\n## Limitations\nThe Docker/Podman fallback is only tested on Linux.\nIf you experience issues with it on Windows or macOS, please install shfmt.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhukkin%2Fmdformat-shfmt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhukkin%2Fmdformat-shfmt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhukkin%2Fmdformat-shfmt/lists"}