diff options
| author |  Joel Kuzmarski <leoj3n@gmail.com>
| 2022-02-25 10:18:48 -0600 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2022-02-25 08:18:48 -0800 |
| commit | c46db4ecbd1dfbe68679167b27e7f1d92e27f5fb (patch) | |
| tree | b81ee82540b5ee6c5ac14e9b9a3cbe8c796a0858 /examples/non-html-pages/README.md | |
| parent | 7680fd511882282be70785b42a62627876319eda (diff) | |
| download | astro-c46db4ecbd1dfbe68679167b27e7f1d92e27f5fb.tar.gz astro-c46db4ecbd1dfbe68679167b27e7f1d92e27f5fb.tar.zst astro-c46db4ecbd1dfbe68679167b27e7f1d92e27f5fb.zip | |
Add Non-HTML Pages example (#2637)
* Add Non-HTML Pages example
* Rename dir non-html-example to non-html-pages
* Update name to non-html-pages in package.json
Diffstat (limited to 'examples/non-html-pages/README.md')
| -rw-r--r-- | examples/non-html-pages/README.md | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/examples/non-html-pages/README.md b/examples/non-html-pages/README.md new file mode 100644 index 000000000..354f95be3 --- /dev/null +++ b/examples/non-html-pages/README.md @@ -0,0 +1,48 @@ +# Astro Starter Kit: Non-HTML Pages + +Documentation for "Non-HTML Pages": + +https://docs.astro.build/en/core-concepts/astro-pages/#non-html-pages + +``` +npm init astro -- --template non-html-pages +``` + +[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/non-html-pages) + +> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun! + +## 🚀 Project Structure + +Inside of your Astro project, you'll see the following folders and files: + +``` +/ +├── public/ +├── src/ +│ └── pages/ +│ └── index.astro +│ └── company.json.ts +└── 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: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). |