Getting Started

Add a scroll to top button to your documentation website.

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. starlight-scroll-to-top is a Starlight plugin. Install it by running the following command in your terminal:

   npm

   npm install starlight-scroll-to-top

   pnpm

   pnpm add starlight-scroll-to-top

   Yarn

   yarn add starlight-scroll-to-top

2. Configure the plugin in your Starlight configuration in the astro.config.mjs file.

   astro.config.mjs

   import starlight from '@astrojs/starlight'
   import { defineConfig } from 'astro/config'
   import starlightScrollToTop from 'starlight-scroll-to-top'
   
   export default defineConfig({
     integrations: [
       starlight({
         plugins: [starlightScrollToTop()],
         title: 'My Docs',
       }),
     ],
   })

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