https://github.com/hukkin/mdformat-gofmt

Mdformat plugin to gofmt Go code blocks
https://github.com/hukkin/mdformat-gofmt

gofmt markdown mdformat

Last synced: about 1 month ago
JSON representation

Mdformat plugin to gofmt Go code blocks

• Host: GitHub
• URL: https://github.com/hukkin/mdformat-gofmt
• Owner: hukkin
• License: mit
• Created: 2020-10-20T06:24:54.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-02T09:42:16.000Z (over 1 year ago)
• Last Synced: 2025-10-15T07:37:56.645Z (8 months ago)
• Topics: gofmt, markdown, mdformat
• Language: Python
• Homepage:
• Size: 18.6 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://github.com/hukkinj1/mdformat-gofmt/workflows/Tests/badge.svg?branch=master)]()

[![PyPI version]()]()

# mdformat-gofmt

> Mdformat plugin to gofmt Go code blocks

## Description

mdformat-gofmt is an [mdformat](https://github.com/executablebooks/mdformat) plugin

that makes mdformat format Go code blocks with [gofmt](https://golang.org/cmd/gofmt).

The plugin invokes gofmt in a subprocess so having Go installed is a requirement.

## Installing

1. [Install Go](https://golang.org/doc/install)

1. Install mdformat-gofmt

   ```bash

   pip install mdformat-gofmt

   ```

## Usage

```bash

mdformat YOUR_MARKDOWN_FILE.md

```