xevion/undefined.behavio.rs
1
0
Fork 0
mirror of https://github.com/Xevion/undefined.behavio.rs.git synced 2025-12-09 12:09:13 -06:00
Code Issues Packages Projects Releases Wiki Activity

Continue tuning header size & margin, fix README, fix repository URL string

Browse Source
This commit is contained in:
Xevion
2023-11-27 17:15:24 -06:00
parent 884638091c
commit 36a293541c
2 changed files with 29 additions and 57 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
README.md
View File

@@ -1,54 +1,28 @@
# Astro Starter Kit: Basics
# undefined.behavio.rs
```sh
npm create astro@latest -- --template basics
```
## Project Structure
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/basics)
[![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)
| Path | Description |
| :--------------------------------- | :------------------------------------------------ |
| `/src/components` | Reusable building blocks |
| `/src/layouts ` | Layouts are components used to structure the page |
| `/src/content/config.ts` | Content collection definitions |
| `/src/content/blog` | Stores blog posts |
| `/src/pages/index.astro` | Site Index |
| `/src/pages/pages/[...slug].astro` | Catch all route that serves blog content |
| `/public/fonts/` | Special font assets used in the site |
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
![just-the-basics](https://github.com/withastro/astro/assets/2244813/a0a5533c-a856-4198-8470-2d67b1d7c554)
## 🚀 Project Structure
Inside of your Astro project, you'll see the following folders and files:
```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
## 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 |
| Command | Action |
| :------------------------- | :----------------------------------------------- |
| `pnpm install` | Installs dependencies |
| `pnpm run dev` | Starts local dev server at `localhost:4321` |
| `pnpm run build` | Build your production site to `./dist/` |
| `pnpm run preview` | Preview your build locally, before deploying |
| `pnpm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `pnpm 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).
Documentation is available [here](https://docs.astro.build).