Skip to content

Getting Started

Prepare your Astro project to use all available components from the astro-contributors package.

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.

astro-contributors is an npm package that exports multiple Astro components. Install the package by running the following command in your terminal:

Terminal window
npm install astro-contributors

The “Using Components” guide explains how to use components in MDX and Markdoc.

Check out the ContributorList and the AllContributors components, which are exported by this package and can be imported via:

import { ContributorList } from "astro-contributors"
<ContributorList githubRepo="trueberryless-org/astro-contributors" />
Preview
  • trueberryless
  • renovate[bot]
  • github-actions[bot]
  • trueberryless-org[bot]
  • autofix-ci[bot]
  • trueberryless-bot
  • JimMadge