Customize Starlight beyond the defaults
A Starlight plugin that extends core UI components with custom navigation links, ads, marketing footers, and a cleaner theme toggle.
What's Included
Powerful UI enhancements for Starlight
Add professional touches to your documentation site with features that work together to create a polished, marketing-ready experience.
- Enhanced Navbar
-
Add custom links to your navbar for external resources, API references, or marketing pages.
- Cleaner Theme Selector
-
Swap Starlight's text-based theme selector for a sleek icon that saves space and looks modern.
- Monetize Your Documentation
-
Promote products, services, or related tools without disrupting the reading flow.
- Professional Site Footer
-
Create a polished footer experience with multiple columns for product links, resources, support options, and company information.
Frequently asked questions
Can’t find the answer you’re looking for? Send us an email.
- Does this work with all Starlight themes?
- Yes, Starlight UI Tweaks is designed to work seamlessly with Starlight's default theme and most custom themes. The plugin extends core components without breaking existing functionality.
- Will this affect my existing Starlight configuration?
- No, the plugin only adds new features without modifying your existing Starlight setup. You can enable or disable features independently, and removing the plugin won't break your site.
- Can I use only some features and not others?
- Absolutely. Each feature is optional and independent. You can add navbar links without using the footer, or use the ad placement without changing the theme toggle. Configure only what you need.
- Does the footer appear on all pages?
- No, the marketing footer only appears on pages using Starlight's splash template. Regular documentation pages keep their standard layout while landing pages get the full marketing treatment.
- How does internationalization work?
- All customizable content can be translated for different locales. Simply provide translations in the locales configuration object, matching the locale keys you've defined in Starlight. You only need to translate the features you're using.
- Can I customize the styling of these components?
- The components use Starlight's existing design tokens and styling, so they match your site automatically. For deeper customization, you can override styles using CSS, just like any other Starlight component.
- Does this affect my site's performance?
- No, the plugin is lightweight and only adds minimal overhead. Features are implemented efficiently and follow Starlight's performance best practices.
Transform your Starlight site now
Install Starlight UI Tweaks and customize your documentation site in minutes.