gh-annotate
Adds GitHub links to Markdown files. Perfect for maintaining changelog files. See: gh-annotate(1).
What it does
Running gh-annotate(1) on a file will perform the following things:
- Turns
#847
to issue links. - Turns
@rstacruz
to user links. - Turns
v0.2.4(...v0.2.3)
into compare links.
It is idempotent, so running (and re-running) it on a file should have no side effects.
Example
Given this file:
◦ cat CHANGELOG.md
## v0.8.2
* Fix blabberdupes (@manilajs, #2)
* Improve dapperdonks (@mashupgarage, #8)
Run it:
◦ gh-annotate CHANGELOG.md
And you get this:
◦ cat CHANGELOG.md
## v0.8.2
* Fix blabberdupes ([@manilajs], [#2])
* Improve dapperdonks ([@mashupgarage], [#8])
[@manilajs]: https://github.com/manilajs
[@mashupgarage]: https://github.com/mashupgarage
[#2]: https://github.com/rstacruz/jquery.transit/issues/2
[#8]: https://github.com/rstacruz/jquery.transit/issues/8
Install
npm install -g gh-annotate
Thanks
gh-annotate © 2015+, Rico Sta. Cruz. Released under the MIT License.
Authored and maintained by Rico Sta. Cruz with help from contributors (list).
ricostacruz.com · GitHub @rstacruz · Twitter @rstacruz