Update README.md

This commit is contained in:
Michał 2024-05-26 20:27:00 +01:00
parent e45e012977
commit b90b605956
3 changed files with 8 additions and 48 deletions

BIN
.github/screenshots/Blog.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 987 KiB

BIN
.github/screenshots/Index.png vendored Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 995 KiB

View file

@ -1,54 +1,14 @@
# Astro Starter Kit: Basics # website
```sh Made in Astro because idk, but I hated it
npm create astro@latest -- --template basics
```
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics) Mostly used to show what I can do, kinda a portfolio I guess?
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/basics)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/basics/devcontainer.json)
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun! ---
![just-the-basics](https://github.com/withastro/astro/assets/2244813/a0a5533c-a856-4198-8470-2d67b1d7c554) ![Index.png](.github/screenshots/Index.png)
![Index.png](.github/screenshots/Blog.png)
## 🚀 Project Structure ---
Inside of your Astro project, you'll see the following folders and files: aurgh
```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 |
## 👀 Want to learn more?
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).