Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

plouc/mozaik-ext-github

Repository files navigation

Mozaïk GitHub widgets

License Travis CI NPM version Dependencies Coverage Status widget count

Deploy

This branch contains code for the version compatible with Mozaïk v2, if you're looking for v1, please use mozaik-1 branch.

This repository contains some GitHub widgets to use with Mozaïk.

Demo

You can see a live demo of the widgets here

Widgets

Github Client Configuration

In order to use the Mozaïk github widgets, you should configure its client. It's not required that you provide a token for authentication, but then you'll only be able to see public repos and the rate limit will apply.

parameters

key env key required default description
token GITHUB_API_TOKEN no '' github authentication token
baseUrl GITHUB_BASE_URL no https://api.github.com github api url (useful for enterprise)

usage

# config.yml
api:
 github:
 baseUrl: ""
 token: MY_GITHUB_TOKEN

Widgets doc

Badges

OrgBadge

Show github organization badge.

github organization badge

parameters
key required description
org yes github organization identifier
title no overrides default title if provided
usage
# config.yml
dashboards:
- # ...
 widgets:
 - extension: github
 widget: OrgBadge
 organization: github
 columns: 1
 rows: 1
 x: 0
 y: 0

RepoBadge

Show repository info.

parameters
key required description
repository yes github repository
title no overrides default title if provided
usage
# config.yml
dashboards:
- # ...
 widgets:
 - extension: github
 widget: RepoBadge
 repository: plouc/mozaik
 columns: 1
 rows: 1
 x: 0
 y: 0

UserBadge

Show github user badge.

github user badge

parameters
key required description
user yes github user identifier
title no overrides default title if provided
usage
# config.yml
dashboards:
- # ...
 widgets:
 - extension: github
 widget: UserBadge
 user: plouc
 columns: 1
 rows: 1
 x: 0
 y: 0

Stats

RepoCommitActivityHistogram

parameters
key required description
repository yes github repository
title no overrides default title if provided
usage
# config.yml
dashboards:
- # ...
 widgets:
 - extension: github
 widget: RepoCommitActivityHistogram
 repository: plouc/mozaik
 columns: 2
 rows: 1
 x: 0
 y: 0

RepoCommitActivityLine

parameters
key required description
repository yes github repository
title no overrides default title if provided
usage
# config.yml
dashboards:
- # ...
 widgets:
 - extension: github
 widget: RepoCommitActivityLine
 repository: plouc/mozaik
 columns: 2
 rows: 1
 x: 0
 y: 0

RepoContributorsStats

parameters
key required description
repository yes github repository
title no overrides default title if provided
usage
# config.yml
dashboards:
- # ...
 widgets:
 - extension: github
 widget: RepoContributorsStats
 repository: plouc/mozaik
 columns: 2
 rows: 1
 x: 0
 y: 0

Traffic

RepoTrafficClonesHistogram

parameters
key required description
repository yes github repository
title no overrides default title if provided
usage
# config.yml
dashboards:
- # ...
 widgets:
 - extension: github
 widget: RepoTrafficClonesHistogram
 repository: plouc/mozaik
 columns: 2
 rows: 1
 x: 0
 y: 0

RepoTrafficClonesLine

parameters
key required description
repository yes github repository
title no overrides default title if provided
usage
# config.yml
dashboards:
- # ...
 widgets:
 - extension: github
 widget: RepoTrafficClonesLine
 repository: plouc/mozaik
 columns: 2
 rows: 1
 x: 0
 y: 0

RepoTrafficViewsHistogram

parameters
key required description
repository yes github repository
title no overrides default title if provided
usage
# config.yml
dashboards:
- # ...
 widgets:
 - extension: github
 widget: RepoTrafficViewsHistogram
 repository: plouc/mozaik
 columns: 2
 rows: 1
 x: 0
 y: 0

RepoTrafficViewsLine

parameters
key required description
repository yes github repository
title no overrides default title if provided
usage
# config.yml
dashboards:
- # ...
 widgets:
 - extension: github
 widget: RepoTrafficViewsLine
 repository: plouc/mozaik
 columns: 2
 rows: 1
 x: 0
 y: 0

Branches

Show github branches with authors.

github repository branches

parameters

key required description
repository yes github repository
title no overrides default title if provided

usage

# config.yml
dashboards:
- # ...
 widgets:
 - extension: github
 widget: Branches
 repository: plouc/mozaik
 columns: 1
 rows: 1
 x: 0
 y: 0

PullRequests

Show github repository pull requests with authors.

parameters

key required description
repository yes github repository
title no overrides default title if provided

usage

# config.yml
dashboards:
- # ...
 widgets:
 - extension: github
 widget: PullRequests
 repository: plouc/mozaik
 columns: 1
 rows: 1
 x: 0
 y: 0

Status

Shows the latest Github system status information from https://status.github.com/

Github Status

usage

# config.yml
dashboards:
- # ...
 widgets:
 - extension: github
 widget: Status
 columns: 1
 rows: 1
 x: 0
 y: 0

Packages

No packages published

Contributors 3

AltStyle によって変換されたページ (->オリジナル) /