update readme

This commit is contained in:
Noah Swerhun 2024-03-15 12:33:26 -05:00
parent dbfb0bc329
commit 0de74d2092
3 changed files with 767 additions and 395 deletions

View file

@ -1,37 +1,6 @@
# Astro Starter Kit: Minimal # noahsw.xyz
```sh Built with Astro and Tailwind.
npm create astro@latest -- --template minimal
```
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/astro/tree/latest/examples/minimal)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/minimal)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/minimal/devcontainer.json)
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
## 🚀 Project Structure
Inside of your Astro project, you'll see the following folders and files:
```text
/
├── public/
├── src/
│ └── 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 | | Command | Action |
| :------------------------ | :----------------------------------------------- | | :------------------------ | :----------------------------------------------- |
@ -41,7 +10,3 @@ All commands are run from the root of the project, from a terminal:
| `npm run preview` | Preview your build locally, before deploying | | `npm run preview` | Preview your build locally, before deploying |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` | | `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI | | `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).

View file

@ -10,16 +10,18 @@
"astro": "astro" "astro": "astro"
}, },
"dependencies": { "dependencies": {
"@astrojs/check": "^0.5.9",
"@astrojs/tailwind": "^5.1.0", "@astrojs/tailwind": "^5.1.0",
"astro": "^3.6.4", "astro": "^3.6.5",
"astro-particles": "^2.10.0", "astro-particles": "^2.10.0",
"tailwindcss": "^3.4.0", "tailwindcss": "^3.4.1",
"tsparticles": "^2.12.0", "tsparticles": "^2.12.0",
"tsparticles-engine": "^2.12.0" "tsparticles-engine": "^2.12.0",
"typescript": "^5.4.2"
}, },
"devDependencies": { "devDependencies": {
"@types/three": "^0.160.0", "@types/three": "^0.160.0",
"prettier": "^3.1.1", "prettier": "^3.2.5",
"prettier-plugin-astro": "^0.12.3" "prettier-plugin-astro": "^0.12.3"
} }
} }

File diff suppressed because it is too large Load diff