Skip to content

shurcooL/markdownfmt

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

markdownfmt

Go Reference

Like gofmt, but for Markdown.

Markdown Format Demo

Note that markdownfmt works with pure Markdown files. If you want to use it with Markdown files that have front matter, consider one of alternatives that supports that.

Installation

go install github.com/shurcooL/markdownfmt@latest

Usage

usage: markdownfmt [flags] [path ...]
  -d  display diffs instead of rewriting files
  -l  list files whose formatting differs from markdownfmt's
  -w  write result to (source) file instead of stdout

Editor Plugins

Alternatives

  • mdfmt - Fork of markdownfmt that adds front matter support.
  • tidy-markdown - Project with similar goals, but written in JS and based on a slightly different styleguide.
  • Flowmark - A JS-based Atom plugin with line wrapping, YAML frontmatter support, and other normalization features.

License