markdownfmt is a CLI that reformats Markdown files (like gofmt
but for Markdown) and a library that you can use to generate well-formed Markdown files.
Features
#
, ##
) by defaultgo install github.com/Kunde21/markdownfmt/v3/cmd/markdownfmt@latest
go get github.com/Kunde21/markdownfmt/v3@latest
usage: markdownfmt [flags] [path ...]
-d display diffs instead of rewriting files
-gofmt
reformat Go source inside fenced code blocks
-l list files whose formatting differs from markdownfmt's
-list-indent-style value
style for indenting items inside lists ("aligned" or "uniform")
-soft-wraps
wrap lines even on soft line breaks
-u write underline headings instead of hashes for levels 1 and 2
-w write result to (source) file instead of stdout
The markdownfmt CLI supports the following execution modes:
-w
): Reformat and rewrite Markdown files in-place.-l
): List files that would be modified, but don't change them.-d
): Display a diff of modifications that would be made to files, but don't change them.markdownfmt began as a fork of shurcooL/markdownfmt targeting Goldmark instead of Blackfriday. It has since diverged significantly.
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.