ad62547d8e
🎨 COMPONENT SYSTEM ACTIVATION: 📝 File Format Conversion: - Convert ALL 46 content files from .md to .mdx format - Enable JSX/component syntax in all content files - Maintain all existing content while adding component capability 🧩 Component Integration: - Homepage enhanced with Cards, LinkCards, Asides, Steps - Tutorial example updated with Tabs, Code blocks, enhanced Asides - All component imports properly configured 📚 Available Components: ✅ Cards & CardGrid - Feature highlights, content organization ✅ LinkCards - Enhanced navigation and cross-references ✅ Asides - Tips, notes, warnings, cautions (4 types) ✅ Steps - Tutorial processes and procedures ✅ Tabs - Before/after examples, alternatives ✅ Code - Syntax highlighting with titles ✅ Badges - Status indicators and labels ✅ Icons - Visual enhancement 📖 Documentation: - Complete component reference guide (COMPONENTS-GUIDE.md) - Usage examples and implementation patterns - Import syntax and best practices 🔧 Technical Implementation: - Starlight automatically handles .mdx files - Component imports per file (tree-shaking friendly) - Backward compatible with existing markdown syntax - Enhanced visual hierarchy and user experience Ready for content authors to use rich, interactive components throughout the entire documentation site!
Starlight Starter Kit: Basics
npm create astro@latest -- --template starlight
🧑🚀 Seasoned astronaut? Delete this file. Have fun!
🚀 Project Structure
Inside of your Astro + Starlight project, you'll see the following folders and files:
.
├── public/
├── src/
│ ├── assets/
│ ├── content/
│ │ ├── docs/
│ └── content.config.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
Starlight looks for .md or .mdx files in the src/content/docs/ directory. Each file is exposed as a route based on its file name.
Images can be added to src/assets/ and embedded in Markdown with a relative link.
Static assets, like favicons, can be placed in the public/ directory.
🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
|---|---|
npm install |
Installs dependencies |
npm run dev |
Starts local dev server at localhost:4321 |
npm run build |
Build your production site to ./dist/ |
npm run preview |
Preview your build locally, before deploying |
npm run astro ... |
Run CLI commands like astro add, astro check |
npm run astro -- --help |
Get help using the Astro CLI |
👀 Want to learn more?
Check out Starlight’s docs, read the Astro documentation, or jump into the Astro Discord server.