Getting Started

Quickly display a link to some download asset on your Starlight site.

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-save-file-component

   pnpm

   pnpm add starlight-save-file-component

   yarn

   yarn add starlight-save-file-component

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

   src/content/docs/example.mdx

   import { SaveFile } from "starlight-save-file-component";
   
   <SaveFile title="Example PDF" href="../../../example.pdf" />

3. Start the development server to preview the component.

Visit the usage guide for more information.