Skip to content

Commit d2920ce

Browse files
committed
Update README
1 parent 32b1cd6 commit d2920ce

File tree

1 file changed

+52
-5
lines changed

1 file changed

+52
-5
lines changed
Lines changed: 52 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,62 @@
1-
# `starlight-telescope`
1+
<div align="center">
2+
<h1>Starlight Telescope</h1>
3+
<p>Quickly navigate to any page in your Starlight docs with fuzzy search and keyboard-first navigation.</p>
24

3-
Quickly navigate to any page in your Starlight docs with fuzzy search and keyboard-first navigation.
5+
[![npm version](https://badge.fury.io/js/starlight-telescope.svg)](https://badge.fury.io/js/starlight-telescope)
6+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
7+
</div>
8+
9+
## Features
10+
11+
- Fuzzy search powered by Fuse.js for fast, typo-tolerant results
12+
- Keyboard-first navigation with customizable shortcuts
13+
- Pin frequently used pages for quick access
14+
- Recent pages history for easy navigation
15+
- Fully customizable theming and styling
16+
- Accessible components with proper ARIA attributes
17+
- Works seamlessly with Starlight's existing configuration
18+
19+
## Installation
20+
21+
Install the plugin using your preferred package manager:
22+
23+
```bash
24+
npm install starlight-telescope
25+
```
26+
27+
## Quick Start
28+
29+
```js
30+
// astro.config.mjs
31+
import starlight from '@astrojs/starlight';
32+
import starlightTelescope from 'starlight-telescope';
33+
34+
export default defineConfig({
35+
integrations: [
36+
starlight({
37+
plugins: [starlightTelescope()],
38+
}),
39+
],
40+
});
41+
```
442

543
## Documentation
644

7-
Want to get started immediately?
45+
For comprehensive documentation, installation guides, configuration options, and examples, visit the [plugin documentation](https://frostybee.github.io/starlight-telescope/).
46+
47+
## Contributing
848

9-
Check out the `starlight-telescope` getting started guide.
49+
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.
1050

1151
## License
1252

1353
Licensed under the MIT License, Copyright © frostybee.
1454

15-
See [LICENSE](https://github.com/frostybee/starlight-telescope/blob/main/LICENSE) for more information.
55+
See [LICENSE](/LICENSE) for more information.
56+
57+
## Links
58+
59+
- [GitHub Repository](https://github.com/frostybee/starlight-telescope)
60+
- [npm Package](https://www.npmjs.com/package/starlight-telescope)
61+
- [Documentation](https://frostybee.github.io/starlight-telescope/)
62+
- [Issues](https://github.com/frostybee/starlight-telescope/issues)

0 commit comments

Comments
 (0)