vue-github

vue-github

vue your github activity and calendar

Demo

Installation

NPM

npm i vue-github

Yarn

yarn add vue-github

Dependencies

Insert an octicons.css file in your html file to load the icons.

<link
  rel="stylesheet"
  href="https://cdnjs.cloudflare.com/ajax/libs/octicons/3.5.0/octicons.min.css"
/>

Usage

Register the component globally in your main javascript file.

import Vue from "vue";
import VueGithub from "vue-github";

Vue.use(VueGithub);

Check out the main.js in the demo repo.

import the style into your main vue file (most likely App.vue) if you want the default css.

<style>
  @import url("https://unpkg.com/vue-github@0.10.7/dist/vueGithub.css");
</style>

In your template you can now use html like this to render the activity feed:

<vue-github username="harps116" />

Props:

Issues

File issues here

License

This project is licensed under MIT License - see the LICENSE file for details

Inspired by these great open source projects:

https://github.com/IonicaBizau/github-calendar

https://github.com/lexmartinez/vue-github-activity