Skip to content

Commit fc30013

Browse files
authored
Update README.md
replace the astro default readme
1 parent 3d34c05 commit fc30013

1 file changed

Lines changed: 1 addition & 43 deletions

File tree

README.md

Lines changed: 1 addition & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1 @@
1-
# Astro Starter Kit: Minimal
2-
3-
```sh
4-
pnpm create astro@latest -- --template minimal
5-
```
6-
7-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
8-
9-
## 🚀 Project Structure
10-
11-
Inside of your Astro project, you'll see the following folders and files:
12-
13-
```text
14-
/
15-
├── public/
16-
├── src/
17-
│ └── pages/
18-
│ └── index.astro
19-
└── package.json
20-
```
21-
22-
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
23-
24-
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
25-
26-
Any static assets, like images, can be placed in the `public/` directory.
27-
28-
## 🧞 Commands
29-
30-
All commands are run from the root of the project, from a terminal:
31-
32-
| Command | Action |
33-
| :------------------------ | :----------------------------------------------- |
34-
| `pnpm install` | Installs dependencies |
35-
| `pnpm dev` | Starts local dev server at `localhost:4321` |
36-
| `pnpm build` | Build your production site to `./dist/` |
37-
| `pnpm preview` | Preview your build locally, before deploying |
38-
| `pnpm astro ...` | Run CLI commands like `astro add`, `astro check` |
39-
| `pnpm astro -- --help` | Get help using the Astro CLI |
40-
41-
## 👀 Want to learn more?
42-
43-
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
1+
Github repo for my personal site :)

0 commit comments

Comments
 (0)