Démarrage

Naviguez rapidement vers n’importe quelle page de votre documentation Starlight grâce à la recherche floue et la navigation au clavier.

Prérequis

Vous devez avoir un site Starlight configuré. Si vous n’en avez pas encore, vous pouvez suivre le guide “Mise en route” dans la documentation Starlight pour en créer un.

Installation

1. starlight-telescope est un plugin Starlight. Installez-le en exécutant la commande suivante dans votre terminal :

   npm

   npm install starlight-telescope

   pnpm

   pnpm add starlight-telescope

   Yarn

   yarn add starlight-telescope

2. Configurez le plugin dans votre configuration Starlight dans le fichier astro.config.mjs.

   astro.config.mjs

   import starlight from '@astrojs/starlight'
   import { defineConfig } from 'astro/config'
   import starlightTelescope from 'starlight-telescope'
   
   export default defineConfig({
     integrations: [
       starlight({
         plugins: [starlightTelescope()],
         title: 'Ma Documentation',
       }),
     ],
   })

3. Démarrez le serveur de développement pour prévisualiser le plugin en action.