personal-website/README.md

43 lines
1.6 KiB
Markdown
Raw Normal View History

# Personal themeable i18n compatible website in astro
2024-03-19 12:59:26 +01:00
Code for my personal website written in astro with react.js elements.
i18n compatible (even blog), easily CSS stylable (one .css file for everything)
2024-03-19 12:59:26 +01:00
## 🚀 Project Structure
2024-06-03 08:50:23 +02:00
The file & folder structure is as follows:
2024-03-19 12:59:26 +01:00
```text
/
├── public/
│ └── favicon.svg
├── src/
│ ├── components/
│ │ └── Card.astro
│ ├── layouts/
│ │ └── Layout.astro
│ └── pages/
│ └── index.astro
└── package.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.
## 🧞 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 |