Features

• Fuzzy search powered by Fuse.js for fast, typo-tolerant results
• Keyboard-first navigation with customizable shortcuts
• Pin frequently used pages for quick access
• Recent pages history for easy navigation
• Fully customizable theming and styling
• Accessible components with proper ARIA attributes
• Works seamlessly with Starlight's existing configuration

Installation

Install the plugin using your preferred package manager:

npm install starlight-telescope

Quick Start

// astro.config.mjs
import starlight from '@astrojs/starlight';
import starlightTelescope from 'starlight-telescope';

export default defineConfig({
  integrations: [
    starlight({
      plugins: [starlightTelescope()],
    }),
  ],
});

Documentation

For comprehensive documentation, installation guides, configuration options, and examples, visit the plugin documentation.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

License

Licensed under the MIT License, Copyright © frostybee.

See LICENSE for more information.

Links

• GitHub Repository
• npm Package
• Documentation
• Issues