JavaScript CSS HTML
Switch branches/tags
Nothing to show
Clone or download
Latest commit ddc806f Jun 20, 2018
Permalink
Failed to load latest commit information.
assets 1.5.0 Jun 20, 2018
demo 1.5.0 Jun 20, 2018
extensions chore: bump version Jun 20, 2018
screenshots update screenshots Mar 9, 2017
src 1.5.0 Jun 20, 2018
userscript chore: bump version Jun 20, 2018
.editorconfig 1.5.0 Jun 20, 2018
.gitignore 0.0.1 Aug 11, 2015
CHANGELOG.md 1.5.0 Jun 20, 2018
Gulpfile.js 1.5.0 Jun 20, 2018
LICENSE add options/preferences, suppor GitHub Enterprise. Oct 10, 2015
README.md use triple click to trigger token form Jul 21, 2017
favicon.ico add favicon Feb 7, 2016
icon.png fix logo path Aug 15, 2015
index.html chore: bump version Jun 20, 2018
package-lock.json update marked version Jan 5, 2018
package.json chore: bump version Jun 20, 2018

README.md

GitHub Hovercard

Neat hovercards for GitHub.

Installation

Published versions

Manual installation

FAQ

  • Why and how should I bind my access token and which scopes should I allow?

    GitHub limits unauthenticated API requests to 60 per hour but after binding your access token you will be able to enjoy the rate limit of 5,000 requests per hour.

    Triple click on any hovercard and the access token form will pop out.

    You should at lease add permission for public_repo to enable star/unstar, and user:follow to enable follow/unfollow.

  • How can I make the follow/unfollow button work?

    First you need to provide an access token with adequate scopes.

  • Why Chrome warns me the extension might read my browser history?

    It's because GitHub Hovercard uses webNavigation module to dynamically inject content scripts (to support GitHub Enterprise). See #34. GitHub Hovercard won't track or record any of these private data.

  • Why can GitHub Hovercard's demo page find out I have installed the extension or not?

    In Chrome/Opera it's allowed to get this information through the API while in Firefox the extension will add a special attribute (data-github-hovercard) to the page's body element so that the demo page can find out if the user has installed GitHub Hovercard. It's all about user experience and the extension itself won't track or record these data.

  • Why access token doesn't work?

    Now GitHub Hovercard is saving user's private access token into localStorage. localStorage has a limit of 5MB and the problem might be other extensions have consumed too much storage that GitHub Hovercard failed to save access tokens.

Options

For browser extension versions, GitHub Hovercard provide following options:

  • Domain

    Use this option to set custom domains for your GitHub Enterprise service. Note that you don't need to set github.com because it's always included. You may be asked to grant additional permissions for those domains.

  • Delay

    If you don't want the hovercards to pop up instantly, you may set a delay before they try to retrieve data and appear.

  • Readme

    You may disable readme content for repo cards if you don't need it.

  • Show self

    You may choose if you want to show user hovercard for yourself.

Screenshots

Users in trending repo avatars

Repos in activity feeds

Users/organizations in repo titles

Forked repos

User/organization links anywhere

Issues

Pull requests

Commits

Known issues

For unauthenticated requests, GitHub API has a fairly low request limit.

In later versions I might introduce access tokens to increase this limit.

Working on it.

Authentication is supported from v0.0.7.

Acknowledgements