6. Usage

6.1. Create User/Organization Cards

  1. Generate a card data file

    Execute ghscard gen <user-name or organization-name>.

    $ ghscard gen thombashi -o data
[INFO] ghscard gen: written user data to 'data/thombashi.json'
  2. Add HTML tags to a HTML file
    <div class='ghscard' src='data/thombashi.json'></div>

<script src="//cdn.jsdelivr.net/gh/thombashi/ghscard@master/dist/ghscard.min.js"></script>
  3. Result

6.2. Create Repository Cards

  1. Generate a card data file

    Execute ghscard gen <user name>/<repository name>.

    $ ghscard gen Microsoft/TypeScript -o data
[INFO] ghscard gen: written repository data to 'data/Microsoft_TypeScript.json'
  2. Add HTML tags to a HTML file
    <div class="ghscard" src="data/Microsoft_TypeScript.json"></div>

<script src="//cdn.jsdelivr.net/gh/thombashi/ghscard@master/dist/ghscard.min.js"></script>
  3. Result

6.3. Card Configurations

6.3.1. card-style Attribute

Card size and display format change according to card-style attribute. card-style attribute takes one of the following values:

  • medium (default)

  • small

  • tiny

Examples

6.3.2. chart-display Attribute

Charts on repository cards can be changed visible or hidden by chart-display attribute value.

chart-display attribute

Value

Meaning

block

Display charts on cards.

none

NOT display charts on cards.

Default value differed by card-style attribute:

Default value of chart-display

card-style value

Default value

medium

block

small

block

tiny

none

Examples

6.3.3. topic-display Attribute

Topic labels repository cards can be changed visible or hidden by topic-display attribute value. Defaults to block.

topic-display attribute

Value

Meaning

block

Display topic labels on cards.

none

NOT display topic labels on cards.

Examples

7. Advanced Usage

7.1. GitHub API Token Setting

You can set GitHub API token via ghscard configure command to workaround GitHub API rate limit. You might exceed GitHub API rate limit when creating card data by ghscard gen command. Git Hub API token can create at https://github.com/settings/tokens/new

$ ghscard configure
GitHub API Personal Access Token: <token>
Output Directory Path [.]: