Six - Starlight Theme

Clean and modern Astro.js Starlight theme

Six is a clean, modern, and highly customizable Starlight theme designed for developers and teams who want a professional documentation experience. Built with flexibility and performance in mind by Six Technology, it provides an elegant design that works seamlessly across all devices.

Installation

Prerequisites

• Node.js 18+
• pnpm
• Astro 5.0+
• Starlight 0.30+

Quick Start

1. Install the theme and required fonts:

   pnpm install @six-tech/starlight-theme-six @fontsource/inter @fontsource/jetbrains-mono

2. Add to your Starlight configuration:

   import starlight from '@astrojs/starlight'
   import starlightThemeSix from '@six-tech/starlight-theme-six'
   // astro.config.ts
   import { defineConfig } from 'astro/config'
   
   export default defineConfig({
     integrations: [
       starlight({
         plugins: [
           starlightThemeSix({
             // Optional: Add navigation links
             navLinks: [
               {
                 label: 'GitHub',
                 link: 'https://github.com/your-repo',
                 attrs: { target: '_blank' }
               }
             ],
             // Optional: Custom footer text
             footerText: 'Built with ❤️ by your team'
           })
         ]
       })
     ]
   })

3. Start developing:

   pnpm run dev

Quick Customizations

• navLinks: Add custom navigation links to the sidebar
• footerText: Customize the footer text
• customCss: Add additional CSS files

Custom Components

Six includes several custom components to enhance your documentation:

• HeroX: Full-width hero sections with customizable content.
• GridX: Flexible grid layouts for showcasing features (similar to, for example, Boostrap column grid).
• ContainerSectionX: Container components with various layouts.
• FigmaX: Embed Figma designs in the documentation page.
• YouTubeX: YouTube video embeds.

Origin

This theme is based on the excellent Starlight Black Theme by Adrián UB.

MIT License © 2025-PRESENT Six Technology