diff options
Diffstat (limited to 'examples/non-html-pages/README.md')
-rw-r--r-- | examples/non-html-pages/README.md | 52 |
1 files changed, 0 insertions, 52 deletions
diff --git a/examples/non-html-pages/README.md b/examples/non-html-pages/README.md deleted file mode 100644 index c26b01698..000000000 --- a/examples/non-html-pages/README.md +++ /dev/null @@ -1,52 +0,0 @@ -# Astro Starter Kit: Non-HTML Pages - -Documentation for "Non-HTML Pages": - -https://docs.astro.build/en/core-concepts/endpoints/#static-file-endpoints - -```sh -npm create astro@latest -- --template non-html-pages -``` - -[](https://stackblitz.com/github/withastro/astro/tree/latest/examples/non-html-pages) -[](https://codesandbox.io/p/sandbox/github/withastro/astro/tree/latest/examples/non-html-pages) -[](https://codespaces.new/withastro/astro?devcontainer_path=.devcontainer/non-html-pages/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 -│ └── about.json.ts -└── package.json -``` - -Astro looks for `.astro`, `.js` or `.ts` 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: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 | - -## 👀 Want to learn more? - -Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat). |