Getting Started

Features

• Support for various package managers: npm, yarn, pnpm, bun & ni.
• Support for various types of command: add, create, dlx, exec, run & remove.
• Synced tabs between each instance on the same page.
• Customizable output with extra arguments, comments & prefixes.

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.

Installation

1. Install the Starlight Package Managers component using your favorite package manager:

   npm

   npm i starlight-package-managers

   pnpm

   pnpm add starlight-package-managers

   yarn

   yarn add starlight-package-managers

   ni

   ni starlight-package-managers

2. Use the component in any MDX files of your Starlight documentation site.

   src/content/docs/example.mdx

   import { PackageManagers } from 'starlight-package-managers'
   
   <PackageManagers pkg="astro" />

3. Start the development server to preview the component.

For more details and examples, please refer to the usage guide.

You can also check the package managers guide for more information about the supported package managers and how to customize them.