Skip to content

Parameters

The ContributorList component supports the following parameters:

Type: ${string}/${string}
Required

Define the GitHub repository to fetch contributors from in the format owner/repo.

import { ContributorList } from "astro-contributors"
<ContributorList githubRepo="trueberryless-org/starlight-view-modes" />

Type: string[]
Optional

An array of GitHub usernames to ignore when fetching contributors. This feature is very useful if you have a bot account that you don’t want to display.

import { ContributorList } from "astro-contributors"
<ContributorList githubRepo="trueberryless-org/starlight-view-modes" ignore={["autofix-ci[bot]", "github-actions[bot]", "renovate[bot]"]} />

Type: string
Optional

The accent color used for the avatar background and focus outlines. This can be any valid CSS color value (Hex, RGB, HSL, etc.).

If not provided, the component will first check for a global CSS variable named --avatar-focus-color, then fall back to Starlight’s --sl-color-accent, and finally default to a standard blue.

import { ContributorList } from "astro-contributors"
<ContributorList
githubRepo="trueberryless-org/starlight-view-modes"
focusColor="#ff5733"
/>

You can notice the focus color, when you use keyboard navigation.