diff options
Diffstat (limited to 'examples/minimal/README.md')
-rw-r--r-- | examples/minimal/README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/examples/minimal/README.md b/examples/minimal/README.md new file mode 100644 index 000000000..dcd6fb136 --- /dev/null +++ b/examples/minimal/README.md @@ -0,0 +1,34 @@ +# [Astro](https://astro.build) + +Inside of your Astro project, you'll see the following folders and files: + +``` +/ +├── public/ +│ ├── robots.txt +│ └── favicon.ico +├── 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 | +|:----------------|:--------------------------------------------| +| `npm install` | Installs dependencies | +| `npm start` | Starts local dev server at `localhost:3000` | +| `npm run build` | Build your production site to `./dist/` | + +## 👀 Want to learn more? + +Feel free to check [our documentation](https://github.com/snowpackjs/astro) or jump into our [Discord server](https://astro.build/chat). |