Velocity Documentation — Official docs for the Velocity Astro 6 starterkit.
Live Site · Velocity Repo · CLI Tool
Documentation site for Velocity, built with Starlight (Astro's documentation framework).
| Section | Description |
|---|---|
| Getting Started | Installation, prerequisites, project structure |
| Components | 55 components across UI, layout, patterns, blog, landing, and SEO |
| Design System | Three-tier token architecture, colors, dark mode, Tailwind utilities |
| Customization | Brand colors, themes, adding components/routes/collections |
| Configuration | Site config, environment variables, routing |
| Content Management | Blog posts, authors, FAQs, pages |
| Layouts | Base, Page, Blog, and Landing layouts |
| SEO | Meta tags, OG images, structured data, sitemap |
| CLI | create-velocity-astro usage, flags, i18n |
| API | Contact and newsletter endpoints |
| Deployment | Vercel, Netlify, Cloudflare Pages |
| Reference | Changelog, quick reference |
| Upgrade Guides | Step-by-step migration between releases |
pnpm install
pnpm devVisit http://localhost:4321 to preview the docs locally.
| Command | Action |
|---|---|
pnpm dev |
Start dev server at localhost:4321 |
pnpm build |
Build production site to dist/ |
pnpm preview |
Preview production build locally |
Docs are .mdx files in src/content/docs/. Each file becomes a route based on its path. Starlight handles navigation, search (Pagefind), and theming automatically.
src/content/docs/
├── getting-started/
├── components/
├── design-system/
├── customization/
├── ...
└── index.mdx
- Astro + Starlight — Documentation framework
- Vercel — Hosting and deployment
- Pagefind — Client-side search
- velocity — The starterkit itself
- create-velocity-astro — CLI scaffolding tool
Built & maintained by Southwell Media