Skip to content

Latest commit

 

History

History
73 lines (58 loc) · 2.4 KB

README.md

File metadata and controls

73 lines (58 loc) · 2.4 KB

GitHub Cards

A library which lets you embed github profiles/repos.

Discord

GitHub last commit GitHub commit activity
GitHub code size in bytes GitHub contributors

Usage

Import

Profile Cards

<link rel="stylesheet" href="https://lyzev.github.io/GitHubCards/min/gh-profilecard.min.css">
<script src="https://lyzev.github.io/GitHubCards/min/gh-profilecard.min.js"></script>

Repo Cards

<link rel="stylesheet" href="https://lyzev.github.io/GitHubCards/min/gh-repocard.min.css">
<script src="https://lyzev.github.io/GitHubCards/min/gh-repocard.min.js"></script>

Use

Profile Cards

<gh-profilecard user="username"></gh-profilecard>

Repo Cards

<gh-repocards amount="amount of random repos" user="username"></gh-repocards>

or

<gh-repocard user="username" repo="repository"></gh-repocard>

Example

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Test</title>
</head>
<body>

<gh-profilecard user="lyzev"></gh-profilecard>
<link rel="stylesheet" href="https://lyzev.github.io/GitHubCards/min/gh-profilecard.min.css">
<script src="https://lyzev.github.io/GitHubCards/min/gh-profilecard.min.js"></script>

<gh-repocard user="lyzev" repo="DcLogger"></gh-repocard>
<gh-repocards amount="5" user="lyzev"></gh-repocards>
<link rel="stylesheet" href="https://lyzev.github.io/GitHubCards/min/gh-repocard.min.css">
<script src="https://lyzev.github.io/GitHubCards/min/gh-repocard.min.js"></script>

</body>
</html>

Example Image

Bugs and Suggestions

Bug reports and suggestions should be made in this repo's issue tracker using the templates provided. Please provide as much information as you can to best help us understand your issue and give a better chance of it being resolved.