Getting Started

Display a list of all contributors to your project.

Prerequisites

You will need to have a Starlight website set up. If you don’t have one yet, you can follow the “Getting Started” guide in the Starlight docs to create one.

Note

If your repository is private, you need to configure the PUBLIC_GITHUB_TOKEN environment variable in your GitHub Secrets. If the repository is public, you can skip this step.

Installation

1. starlight-contributor-list is a Starlight plugin. Install it by running the following command in your terminal:

   npm

   npm install starlight-contributor-list

   pnpm

   pnpm add starlight-contributor-list

   Yarn

   yarn add starlight-contributor-list

2. In any .mdx or .astro file, import the ContributorList component by adding the following import statement:

   mdx

   import { ContributorList } from "starlight-contributor-list";

   astro

   ---
   import { ContributorList } from "starlight-contributor-list"
   ---

3. Now you can use the ContributorList component within this file:

   mdx

   <ContributorList githubRepo="trueberryless-org/mutanuq" />

   astro

   <ContributorList githubRepo="trueberryless-org/mutanuq" />

4. Start the development server to preview the plugin in action.

Check out the parameters which you can pass to the ContributorList component.