diff options
| author |  Okiki <okikio.dev@gmail.com>
| 2021-08-14 00:58:00 +0000 |
|---|---|---|
| committer |  Fred K. Schott <fkschott@gmail.com>
| 2021-08-26 12:15:33 -0700 |
| commit | b7ada11ddbabe4dd2f0798e140e5b280de4d6952 (patch) | |
| tree | c01ff3eee4f770fc108c19d126dce31d9cbe5e51 /examples/docs/src/pages/index.md | |
| parent | 59cc62f7bd53dbcb6ad8051fa501b7b797614178 (diff) | |
| download | astro-b7ada11ddbabe4dd2f0798e140e5b280de4d6952.tar.gz astro-b7ada11ddbabe4dd2f0798e140e5b280de4d6952.tar.zst astro-b7ada11ddbabe4dd2f0798e140e5b280de4d6952.zip | |
WIP update examples/docs/
Diffstat (limited to 'examples/docs/src/pages/index.md')
| -rw-r--r-- | examples/docs/src/pages/index.md | 61 |
1 files changed, 0 insertions, 61 deletions
diff --git a/examples/docs/src/pages/index.md b/examples/docs/src/pages/index.md deleted file mode 100644 index cd5ce6454..000000000 --- a/examples/docs/src/pages/index.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: Hello, Documentation! -layout: ../layouts/Main.astro ---- - -<img src="https://github.com/snowpackjs/astro/blob/main/assets/social/banner.png?raw=true" alt="Astro" width="638" height="320" > - -## What is Astro? - -**Astro** is a _fresh but familiar_ approach to building websites. Astro combines decades of proven performance best practices with the DX improvements of the component-oriented era. - -With Astro, you can use your favorite JavaScript framework and automatically ship the bare-minimum amount of JavaScript—by default, it's none at all! - -## Project Status - -⚠️ **Astro is still an early beta, missing features and bugs are to be expected!** If you can stomach it, then Astro-built sites are production ready and several production websites built with Astro already exist in the wild. We will update this note once we get closer to a stable, v1.0 release. - -## 🔧 Quick Start - -> **Important**: Astro is built with [ESM modules](https://nodejs.org/api/esm.html) which are not supported in older version of Node.js. The minimum supported version is **14.16.1**. - -```bash -# create your project -mkdir new-project-directory -cd new-project-directory -npm init astro - -# install your dependencies -npm install - -# start the dev server and open your browser -npm run dev -``` - -### 🚀 Build & Deployment - -The default Astro project has the following `scripts` in the `/package.json` file: - -```json -{ - "scripts": { - "dev": "astro dev", - "build": "astro build", - "preview": "astro preview" - } -} -``` - -For local development, run: - -``` -npm run dev -``` - -To build for production, run the following command: - -``` -npm run build -``` - -To deploy your Astro site to production, upload the contents of `/dist` to your favorite static site host. |