My minimal personal website built with Astro.
Inside of your Astro project, you'll see the following folders and files:
/
βββ public/
βββ src/
β βββ assets/
β β βββ icons/
β β βββ me_holding_a_cat_square.jpg
β β βββ my_picture.jpg
β βββ components/
β β βββFooter.astro
β β βββNavBar.astro
β β βββProjectCard.astro
β β βββprojects.ts
β β βββTechBadge.astro
β β βββtechs.ts
β βββ layouts/
β β βββAboutLayout.astro
β β βββMainLayout.astro
β βββ pages/
β β βββabout.md
β β βββindex.astro
β βββ env.d.ts
βββ .gitignore
βββ astro.config.mjs
βββ package-lock.json
βββ package.json
βββ README.md
βββ tailwind.config.mjs
βββ tsconfig.json
Astro looks for .astro
or .md
files in the src/pages/
directory. Each page is exposed as a route based on its file name.
There's nothing special about src/components/
, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
Any static assets, like images, 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 |
Feel free to check our documentation or jump into our Discord server.