https://github.com/purplebooth/gfmfmt
Format your markdown into a standard format using pandoc
https://github.com/purplebooth/gfmfmt
Last synced: over 1 year ago
JSON representation
Format your markdown into a standard format using pandoc
- Host: GitHub
- URL: https://github.com/purplebooth/gfmfmt
- Owner: PurpleBooth
- License: cc0-1.0
- Created: 2021-06-15T18:14:50.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-03-10T02:37:55.000Z (over 1 year ago)
- Last Synced: 2025-03-10T03:42:22.414Z (over 1 year ago)
- Language: Shell
- Homepage:
- Size: 38.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# gfmfmt
Format your markdown into a standard format using
[pandoc](https://pandoc.org/)
## A note on Markdown Flavours
While it may appear that Markdown is a single standard, that's not quite
true, there's lots of little extensions to it that make it not exactly
the same across the board. This is intended for use with "[GitHub
Flavoured
Markdown](https://docs.github.com/en/github/writing-on-github)". You can
read more about this on the [pandoc
docs](https://pandoc.org/MANUAL.html#markdown-variants).
The name comes from this fact: gfmfmt, GitHub Flavoured Markdown
Formatter.
## Usage
``` shell
gfmfmt
Billie Thompson
Format GitHub flavour markdown
USAGE:
gfmfmt ...
ARGS:
... Markdown files or folders containing markdown
```
## Installing
Download [gfmfmt](https://github.com/PurpleBooth/gfmfmt/releases/latest)
from the release page
Alternatively use homebrew
``` shell
brew install PurpleBooth/repo/gfmfmt
```