hexo-github

Display a GitHub repositoy badge with timeline in your post to keep track of version difference.

Motive

When referencing an on-going project in an article, some of the content might became un-true or out-of-date as the project evolves, which would certainly cause some confusions to the readers.

This plugin display a badge with timeline for a GitHub repository that will compare latest commit against the referenced one. It should keep the readers informed.

Install

npm install --save hexo-github

Usage

Insert github tag in your article:

{% github user repo referenced_commit [auto_expand = true | false] [width = 100%] %}

Example:

{% github akfish hexo-math b82e65 %}

Known issues & TODO

• It will not work if referenced commit is not in latest 100 ones
• Responsive design
• Mobile layout