gh-annotate
Adds GitHub links to Markdown files. Perfect for maintaining changelog files. See: [gh-annotate(1)].
Last updated 5 years ago by rstacruz .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install gh-annotate 
SYNC missed versions from official npm registry.

gh-annotate

Adds GitHub links to Markdown files. Perfect for maintaining changelog files. See: gh-annotate(1).

Status


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

npm version


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

Current Tags

  • 1.0.0                                ...           latest (5 years ago)

8 Versions

  • 1.0.0                                ...           5 years ago
  • 0.3.0                                ...           5 years ago
  • 0.2.3                                ...           6 years ago
  • 0.2.2                                ...           6 years ago
  • 0.2.1                                ...           6 years ago
  • 0.2.0                                ...           6 years ago
  • 0.1.0                                ...           6 years ago
  • 0.0.1                                ...           6 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (3)
Dev Dependencies (5)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |