Getting Started

Display a list of all contributors to your project.

Prerequisites

You will need to have an Astro website set up. If you don’t have one yet, you can follow the “Install and Setup” guide in the Astro 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. astro-contributors is an Astro component. Install the package by running the following command in your terminal:

   npm

   npm install astro-contributors

   pnpm

   pnpm add astro-contributors

   Yarn

   yarn add astro-contributors

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

   mdx

   import { ContributorList } from "astro-contributors";

   astro

   ---
   import { ContributorList } from "astro-contributors"
   ---

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.