-
Notifications
You must be signed in to change notification settings - Fork 33
HOW TO USE
zmmbreeze edited this page Dec 7, 2014
·
1 revision
Easy way? Copy the following html code to your website.
<script
data-name="your github username"
src="http://octocard.in/o.js"></script>
Advanced way:
<div id="octocard"></div>
<script>
OCTOCARD = {
// [required][string] Username.
name: 'zmmbreeze',
// [optional][string|Element]
// element or elementId, `octocard` as default.
element: 'octocard',
// [optional][string]
// Used module names, default is:
// `base,details,stats,repos,contributions,orgs`.
// You can change the order or remove module if you don't want.
// modules: 'base,details,stats,repos,orgs,eventsStatis',
// [optional][string]specify the theme name to be used
// 'default' as default
// theme: "azzura",
// [optional][number] Number of repos to be shown.
// `3` as default
// reposNum: 4,
// [optional][number]repos which will not be shown
// '' as default
reposIgnored: 'reponame1,reponame2',
// [optional][number] Number of organizations to be shown.
// `Infinity` as default, represent showing all organizations.
// orgsNum: -1,
// [optional][string]url of jsonp api
// `http://octocard.in/api` as default.
// If your use your own octocard-server, change it.
// api: 'http://your-octocard-server.com/api',
// [optional][boolean]show footer or not
// 'false' as default
// noFooter: false,
// [optional][boolean]
// Use `shadowDom` or `iframe` to create isolate container or not
// 'false' as default
// noIsolated: true
};
</script>
<script src="http://octocard.in/o.js"></script>
These configs also work as data-*
attributes.