mirror of
https://github.com/gogrlx/docs.grlx.dev.git
synced 2026-04-02 11:18:58 -07:00
Tai Groot
cd4fe4b069
- Astro 5.1 -> 5.17 - Starlight 0.31 -> 0.37 (social config migrated to array format) - Tailwind CSS 3 -> 4 (migrated to Vite plugin + CSS-based config) - sharp 0.32 -> 0.34 - ESLint 8 -> 9 (migrated to flat config) - Prettier, prettier-plugin-astro, prettier-plugin-tailwindcss updated - Removed dotenv (using Astro import.meta.env) - Removed tailwind.config.mjs (config now in CSS via @theme) - Updated Badge import to new Starlight components path - Node.js 18 -> 22 - Switched from npm to bun
grlx docs
π Project Structure
Inside of your Astro + Starlight project, you'll see the following folders and files:
.
βββ public/
βββ src/
β βββ assets/
β βββ content/
β β βββ docs/
β β βββ config.ts
β βββ env.d.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.