Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shurcooL/markdownfmt
Like gofmt, but for Markdown.
https://github.com/shurcooL/markdownfmt
Last synced: about 1 month ago
JSON representation
Like gofmt, but for Markdown.
- Host: GitHub
- URL: https://github.com/shurcooL/markdownfmt
- Owner: shurcooL
- License: mit
- Created: 2014-03-31T06:14:07.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2024-03-12T17:16:34.000Z (9 months ago)
- Last Synced: 2024-08-02T16:49:26.605Z (4 months ago)
- Language: Go
- Homepage:
- Size: 103 KB
- Stars: 789
- Watchers: 13
- Forks: 63
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- project-awesome - shurcooL/markdownfmt - Like gofmt, but for Markdown. (Go)
- my-awesome-github-stars - shurcooL/markdownfmt - Like gofmt, but for Markdown. (Go)
README
markdownfmt
===========
[](https://pkg.go.dev/github.com/shurcooL/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](#alternatives) that supports that.
Installation
------------
```sh
go install github.com/shurcooL/markdownfmt@latest
```
Usage
-----
```sh
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
--------------
- [vim-markdownfmt](https://github.com/moorereason/vim-markdownfmt) for Vim.
- [emacs-markdownfmt](https://github.com/nlamirault/emacs-markdownfmt) for Emacs.
- [vscode-markdownfmt](https://marketplace.visualstudio.com/itemdetails?itemName=AnmolSinghJaggi.vscode-markdownfmt) for Visual Studio Code.
- Built-in in Conception.
- [markdown-format](https://atom.io/packages/markdown-format) for Atom (deprecated).
- Add a plugin for your favorite editor here?
Alternatives
------------
- [`mdfmt`](https://github.com/moorereason/mdfmt) - Fork of `markdownfmt` that adds front matter support.
- [`tidy-markdown`](https://github.com/slang800/tidy-markdown) - Project with similar goals, but written in JS and based on a slightly different [styleguide](https://github.com/slang800/markdown-styleguide).
- [Flowmark](https://github.com/jlevy/atom-flowmark) - A JS-based Atom plugin with line wrapping, YAML frontmatter support, and other normalization features.
License
-------
- [MIT License](LICENSE)