Skip to content

Commit

Permalink
Add description how to use markdownfmt.sh
Browse files Browse the repository at this point in the history
  • Loading branch information
Jan Suchotzki committed Mar 25, 2015
1 parent 7287ff2 commit 59f3bce
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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?

Expand Down

0 comments on commit 59f3bce

Please sign in to comment.