A plugin for Starlight that adds tagging capabilities to your documentation pages, enabling content organization and discovery through tags.
- Define tags in a centralized
tags.ymlconfiguration file with descriptions and colors - Display tags on documentation pages with customizable badge styling
- Auto-generated tag index page listing all available tags
- Individual tag pages showing all documents with a specific tag
- Pagination support for tag pages with configurable items per page
- Inline tag references in markdown content
- Sidebar component for tag navigation
- Full i18n support (English, French, Spanish, German)
- Accessible components with proper ARIA attributes
Install the plugin using your preferred package manager:
npm install starlight-tags// astro.config.mjs
import starlight from '@astrojs/starlight';
import { starlightTagsPlugin } from 'starlight-tags';
export default defineConfig({
integrations: [
starlight({
plugins: [starlightTagsPlugin()],
}),
],
});For comprehensive documentation, installation guides, configuration options, and examples, visit the plugin documentation.
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.
Licensed under the MIT License, Copyright © frostybee.
See LICENSE for more information.