docker-library
/
docs
mirror of https://github.com/docker-library/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Add description how to use markdownfmt.sh

This commit is contained in:
Jan Suchotzki 2015-03-25 13:58:08 +01:00
parent 7287ff2300
commit 59f3bce161
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -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?