Inside of this Astro + Starlight project, you'll see the following folders and files:
.
├── public/
│ ├── FOSDEM-cog.svg
│ ├── FOSDEM-logo.svg
│ └── favicon.ico
├── src/
│ ├── assets/
│ │ ├── ULB_fire_assembly_points.jpg
│ │ ├── ULB_sos_phone.png
│ │ ├── ULB_wall_phone.png
│ │ ├── fire_red_tape.jpeg
│ │ ├── foam_fire_extinguisher.png
│ │ └── houston.webp
│ ├── content/
│ │ └── docs/
│ │ ├── emergencies/
│ │ ├── general/
│ │ ├── tasks/
│ │ │ ├── buildup-cleanup/
│ │ │ ├── onsite/
│ │ │ ├── virtual/
│ │ │ └── tasklist.md
│ │ ├── video/
│ │ └── index.mdx
│ ├── styles/
│ │ └── fosdem-theme.css
│ └── content.config.ts
├── .gitignore
├── astro.config.mjs
├── package.json
├── README.md
└── 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 and logos, can be placed in the public/ directory.
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 |
This project uses Astro Starlight, licensed under MIT.