diff options
| author |  Ben Holmes <hey@bholmes.dev>
| 2022-04-26 20:37:58 -0400 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2022-04-26 20:37:58 -0400 |
| commit | 8f2f4de5dc9a882030ca01e50cec66ed0f3dfc80 (patch) | |
| tree | 3062763ff37040194f907c1765070b2e992b51d9 /examples/basics/README.md | |
| parent | 15d940867896300011b6687d5bc96d1a6b650239 (diff) | |
| download | astro-8f2f4de5dc9a882030ca01e50cec66ed0f3dfc80.tar.gz astro-8f2f4de5dc9a882030ca01e50cec66ed0f3dfc80.tar.zst astro-8f2f4de5dc9a882030ca01e50cec66ed0f3dfc80.zip | |
Feat: new just the basics template (#3206)
* feat: new just-the-basics example
* chore: update package name
* chore: update lockfile
* refactor: simplify meta tags
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
* refactor: use `system-ui` for base font
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
* Update examples/just-the-basics/src/components/Layout.astro
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
* refactor: just-the-basics -> basics (now 10% more basic!)
* refactor: add type checking to layout prop
* nit: change "astro-text" to "text-gradient"
* refactor: simplify CSS grid
* feat: make transition easing 10% fancier
* change to text gradient because people gooootta have opinions huh
* nit: rename CSS class to "instructions"
* refactor: use ul > li for containers
* chore: update lockfile
* feat: style tweaks
Co-authored-by: Nate Moore <natemoo-re@users.noreply.github.com>
Co-authored-by: Nate Moore <nate@skypack.dev>
Diffstat (limited to 'examples/basics/README.md')
| -rw-r--r-- | examples/basics/README.md | 42 |
1 files changed, 42 insertions, 0 deletions
diff --git a/examples/basics/README.md b/examples/basics/README.md new file mode 100644 index 000000000..15f6eb693 --- /dev/null +++ b/examples/basics/README.md @@ -0,0 +1,42 @@ +# Welcome to [Astro](https://astro.build) + +[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/starter) + +> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! + +## 🚀 Project Structure + +Inside of your Astro project, you'll see the following folders and files: + +``` +/ +├── public/ +│ └── favicon.ico +├── src/ +│ ├── components/ +│ │ └── 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 or layouts. + +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:3000` | +| `npm run build` | Build your production site to `./dist/` | +| `npm run preview` | Preview your build locally, before deploying | + +## 👀 Want to learn more? + +Feel free to check [our documentation](https://github.com/withastro/astro) or jump into our [Discord server](https://astro.build/chat). |