|
1 |
| -# Astro Starter Kit: Minimal |
| 1 | +> [!NOTE] |
| 2 | +> Welcome to the repository for my website. It's not really set up to be directly cloned/copied, but hopefully you can learn/get inspired by poking around and seeing how I did certain things. |
2 | 3 |
|
3 |
| -```sh |
4 |
| -npm create astro@latest -- --template minimal |
5 |
| -``` |
| 4 | +# Andrew's Website |
6 | 5 |
|
7 |
| -[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal) |
8 |
| -[](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal) |
9 |
| -[](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json) |
| 6 | +Learn more about it [here](https://www.amoses.dev/about/). |
10 | 7 |
|
11 |
| -> π§βπ **Seasoned astronaut?** Delete this file. Have fun! |
12 |
| -
|
13 |
| -## π Project Structure |
14 |
| - |
15 |
| -Inside of your Astro project, you'll see the following folders and files: |
16 |
| - |
17 |
| -```text |
18 |
| -/ |
19 |
| -βββ public/ |
20 |
| -βββ src/ |
21 |
| -β βββ pages/ |
22 |
| -β βββ index.astro |
23 |
| -βββ package.json |
24 |
| -``` |
25 |
| - |
26 |
| -Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. |
27 |
| - |
28 |
| -There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. |
29 |
| - |
30 |
| -Any static assets, like images, can be placed in the `public/` directory. |
31 |
| - |
32 |
| -## π§ Commands |
| 8 | +## Commands |
33 | 9 |
|
34 | 10 | All commands are run from the root of the project, from a terminal:
|
35 | 11 |
|
36 |
| -| Command | Action | |
37 |
| -| :------------------------ | :----------------------------------------------- | |
38 |
| -| `npm install` | Installs dependencies | |
39 |
| -| `npm run dev` | Starts local dev server at `localhost:4321` | |
40 |
| -| `npm run build` | Build your production site to `./dist/` | |
41 |
| -| `npm run preview` | Preview your build locally, before deploying | |
42 |
| -| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | |
43 |
| -| `npm run astro -- --help` | Get help using the Astro CLI | |
44 |
| - |
45 |
| -## π Want to learn more? |
46 |
| - |
47 |
| -Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). |
| 12 | +| Command | Action | |
| 13 | +| :---------------- | :------------------------------------------- | |
| 14 | +| `npm install` | Installs dependencies | |
| 15 | +| `npm run dev` | Starts local dev server at `localhost:4321` | |
| 16 | +| `npm run build` | Build your production site to `./dist/` | |
| 17 | +| `npm run preview` | Preview your build locally, before deploying | |
0 commit comments