shurcooL / Markdownfmt
Licence: mit
Like gofmt, but for Markdown.
Stars: ✭ 701
Programming Languages
go
31211 projects - #10 most used programming language
markdownfmt
Like gofmt
, but for Markdown.
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 get -u github.com/shurcooL/markdownfmt
Add $GOPATH/bin
to your $PATH
or copy $GOPATH/bin/markdownfmt
to your $PATH
.
Usage
usage: markdownfmt [flags] [path ...]
-d=false: display diffs instead of rewriting files
-l=false: list files whose formatting differs from markdownfmt's
-w=false: write result to (source) file instead of stdout
Editor Plugins
- vim-markdownfmt for Vim.
- emacs-markdownfmt for Emacs.
- vscode-markdownfmt for Visual Studio Code.
- Built-in in Conception.
- markdown-format for Atom (deprecated).
- Add a plugin for your favorite editor here?
Alternatives
-
mdfmt
- Fork ofmarkdownfmt
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
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].