Skip to content

Commit 1e8ca4c

Browse files
committed
Update README
1 parent f015605 commit 1e8ca4c

File tree

3 files changed

+14
-37
lines changed

3 files changed

+14
-37
lines changed

README.md

Lines changed: 13 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,23 @@
1-
# Astro Starter Kit: Minimal
1+
# cb341.dev
22

3-
```sh
4-
npm create astro@latest -- --template minimal
5-
```
6-
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)
3+
![Preview](public/preview.webp)
104

11-
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
5+
Personal portfolio and blog built with Astro.
126

13-
## 🚀 Project Structure
7+
## Setup
148

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
9+
```sh
10+
npm install
2411
```
2512

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.
13+
## Run
2714

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
33-
34-
All commands are run from the root of the project, from a terminal:
15+
```sh
16+
npm run dev
17+
```
3518

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 |
19+
Visit `localhost:4321` to view the site.
4420

45-
## 👀 Want to learn more?
21+
## License
4622

47-
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).
23+
CC-BY-4.0

bin/run

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
#!/usr/bin/env bash

public/preview.webp

51.3 KB
Loading

0 commit comments

Comments
 (0)