summaryrefslogtreecommitdiff
path: root/examples/docs/src/pages/index.md
diff options
context:
space:
mode:
authorGravatar Fred K. Schott <fkschott@gmail.com> 2021-06-14 12:45:33 -0700
committerGravatar GitHub <noreply@github.com> 2021-06-14 15:45:33 -0400
commit1437b42038bf5daa0ad9e9be41d25f04a8ec97d3 (patch)
tree5d8b63ceddeb6c3475f86441ee84ff365448a49f /examples/docs/src/pages/index.md
parent40720b2c1e6db7d8df9d3f717cd5288363ed17a5 (diff)
downloadastro-1437b42038bf5daa0ad9e9be41d25f04a8ec97d3.tar.gz
astro-1437b42038bf5daa0ad9e9be41d25f04a8ec97d3.tar.zst
astro-1437b42038bf5daa0ad9e9be41d25f04a8ec97d3.zip
fix some example docs site issues (#434)
Diffstat (limited to 'examples/docs/src/pages/index.md')
-rw-r--r--examples/docs/src/pages/index.md60
1 files changed, 60 insertions, 0 deletions
diff --git a/examples/docs/src/pages/index.md b/examples/docs/src/pages/index.md
new file mode 100644
index 000000000..f56477902
--- /dev/null
+++ b/examples/docs/src/pages/index.md
@@ -0,0 +1,60 @@
+---
+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 start
+```
+
+### 🚀 Build & Deployment
+
+The default Astro project has the following `scripts` in the `/package.json` file:
+
+```json
+{
+ "scripts": {
+ "start": "astro dev",
+ "build": "astro build"
+ }
+}
+```
+
+For local development, run:
+
+```
+npm run start
+```
+
+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.