https://github.com/wangkuiyi/mdfmt

Auto reformat Markdown files
https://github.com/wangkuiyi/mdfmt

Last synced: about 1 month ago
JSON representation

Auto reformat Markdown files

• Host: GitHub
• URL: https://github.com/wangkuiyi/mdfmt
• Owner: wangkuiyi
• Created: 2020-06-19T21:42:03.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-06-20T00:09:53.000Z (over 4 years ago)
• Last Synced: 2024-11-25T20:39:21.644Z (about 2 months ago)
• Language: Shell
• Size: 2.93 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• project-awesome - wangkuiyi/mdfmt - Auto reformat Markdown files (Shell)

README

        
# mdfmt

mdfmt automatically reformat Markdown files with some heuristic rules.  

Usually, I run it once for one or more Markdown files and then manually fix the rest of warnings.

1. Run mdfmt with all Markdown files in a directory

   ```bash

   mdfmt *.md

   ```

   

1. Alternatively run the following two steps until no more lint errors.

   1. Run [`markdownlint-cli`](https://github.com/igorshubovych/markdownlint-cli).

   

      ```bash

      markdownlint -c .markdownlint.yaml *.md | sort

      ```

      

   1. Manually fix lint errors.