Enhance your GitHub repo's markdown files.
$ cat CHANGELOG.md
# CHANGELOG
## 2.1.1 / 11 June 2015
- Bugfix for using values from view's context prototype #442 by @phillipj.
- Only display result of master branch on travis badge by @nikolas.
- Upgrade assertion library for proper string diffs #459 by @dasilvacontin.$ gh-sauce CHANGELOG.md
# Dressing CHANGELOG.md with some gh-sauce...
- [x] "CHANGELOG.md" was dressed with gh-sauce
Done! 🍧$ cat CHANGELOG.md
# CHANGELOG
## 2.1.1 / 11 June 2015
- Bugfix for using values from view's context prototype [#442] by [@phillipj].
- Only display result of master branch on travis badge by [@nikolas].
- Upgrade assertion library for proper string diffs [#459] by [@dasilvacontin].
[#442]: https://github.com/mochajs/mocha/issues/442
[#459]: https://github.com/mochajs/mocha/issues/459
[@dasilvacontin]: https://github.com/dasilvacontin
[@nikolas]: https://github.com/nikolas
[@phillipj]: https://github.com/phillipjgh-sauce parses issues and usernames from markdown files and automatically converts them into links. Your markdown will remain clean and easy to read since the URLs will be listed (in alphanumeric order) at the end of the file.
$ npm install -g gh-sauce Usage: gh-sauce [options] <file ...>
Options:
-h, --help output usage information
-V, --version output the version number
-s, --safe Safe mode, doesn't overwrite existing urls
-r, --repo <repo URL> Provide default repo URL for issues
var sauce = require('gh-sauce')
var filename = 'CHANGELOG.md'
var sauceConfig = {
// defaults to false
safe: true
// defaults to local package.json's homepage field
repo: 'https://github.com/dasilvacontin/gh-sauce'
}
fs.readFile(filename, function (err, data) {
var dressed = sauce.dress(data.toString(), sauceConfig)
fs.writeFile(filename, dressed)
})In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using gulp.
MIT © David da Silva
"Octocat with shaved ice" drawing by Núria Balaguer
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent