Skip to content

Commit f646b58

Browse files
committed
revise README
1 parent 20a909e commit f646b58

File tree

1 file changed

+11
-41
lines changed

1 file changed

+11
-41
lines changed

β€ŽREADME.md

Lines changed: 11 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,17 @@
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.
23
3-
```sh
4-
npm create astro@latest -- --template minimal
5-
```
4+
# Andrew's Website
65

7-
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal)
8-
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal)
9-
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json)
6+
Learn more about it [here](https://www.amoses.dev/about/).
107

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
339

3410
All commands are run from the root of the project, from a terminal:
3511

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

Comments
Β (0)