Browse Source

Merge pull request #194 from suchja/markdownfmt

Add description how to use markdownfmt.sh
Tianon Gravi 10 năm trước cách đây
mục cha
commit
d232d49fbb
1 tập tin đã thay đổi với 1 bổ sung0 xóa
  1. 1 0
      README.md

+ 1 - 0
README.md

@@ -18,6 +18,7 @@ All Markdown files here are run through [tianon's fork of `markdownfmt`](https:/
 Optionally: (we run this periodically, especially before pushing updated descriptions)
 
 -	run `./update.sh myimage` to generate `myimage/README.md`
+-	run `./markdownfmt.sh -l myimage` to verify whether format of your markdown files is compliant to markdownfmt. In case you see any file names, markdownfmt detected some issues, which might result in a failed build during continuous integration.
 
 # What are all these files?