diff options
| author |  Jonathan Neal <jonathantneal@hotmail.com>
| 2021-08-15 15:13:58 -0400 |
|---|---|---|
| committer |  GitHub <noreply@github.com>
| 2021-08-15 14:13:58 -0500 |
| commit | d68ac85e7f3041ae4a06ba5dcecaf59a2875b393 (patch) | |
| tree | ff37f541f9f99f4d393e782fd19e24b9f156404a /examples | |
| parent | 072dabe83209c31a357de01dfd97a59ff25e616e (diff) | |
| download | astro-d68ac85e7f3041ae4a06ba5dcecaf59a2875b393.tar.gz astro-d68ac85e7f3041ae4a06ba5dcecaf59a2875b393.tar.zst astro-d68ac85e7f3041ae4a06ba5dcecaf59a2875b393.zip | |
Add minimal template (#1090)
Diffstat (limited to 'examples')
| -rw-r--r-- | examples/minimal/.gitignore | 18 | ||||
| -rw-r--r-- | examples/minimal/.npmrc | 2 | ||||
| -rw-r--r-- | examples/minimal/README.md | 34 | ||||
| -rw-r--r-- | examples/minimal/astro.config.mjs | 3 | ||||
| -rw-r--r-- | examples/minimal/package.json | 12 | ||||
| -rw-r--r-- | examples/minimal/public/robots.txt | 2 | ||||
| -rw-r--r-- | examples/minimal/src/pages/index.astro | 15 |
7 files changed, 86 insertions, 0 deletions
diff --git a/examples/minimal/.gitignore b/examples/minimal/.gitignore new file mode 100644 index 000000000..d436c6dad --- /dev/null +++ b/examples/minimal/.gitignore @@ -0,0 +1,18 @@ +# build output +dist + +# dependencies +node_modules/ +.snowpack/ + +# logs +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# environment variables +.env +.env.production + +# macOS-specific files +.DS_Store diff --git a/examples/minimal/.npmrc b/examples/minimal/.npmrc new file mode 100644 index 000000000..65922326b --- /dev/null +++ b/examples/minimal/.npmrc @@ -0,0 +1,2 @@ +## force pnpm to hoist +shamefully-hoist = true 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). diff --git a/examples/minimal/astro.config.mjs b/examples/minimal/astro.config.mjs new file mode 100644 index 000000000..3a0268bd4 --- /dev/null +++ b/examples/minimal/astro.config.mjs @@ -0,0 +1,3 @@ +export default { + renderers: [], +} diff --git a/examples/minimal/package.json b/examples/minimal/package.json new file mode 100644 index 000000000..aa47c9e5b --- /dev/null +++ b/examples/minimal/package.json @@ -0,0 +1,12 @@ +{ + "name": "@example/minimal", + "version": "0.0.1", + "private": true, + "scripts": { + "start": "astro dev", + "build": "astro build" + }, + "devDependencies": { + "astro": "^0.18.12" + } +} diff --git a/examples/minimal/public/robots.txt b/examples/minimal/public/robots.txt new file mode 100644 index 000000000..1f53798bb --- /dev/null +++ b/examples/minimal/public/robots.txt @@ -0,0 +1,2 @@ +User-agent: * +Disallow: / diff --git a/examples/minimal/src/pages/index.astro b/examples/minimal/src/pages/index.astro new file mode 100644 index 000000000..356373630 --- /dev/null +++ b/examples/minimal/src/pages/index.astro @@ -0,0 +1,15 @@ +--- +--- +<html lang="en"> + +<head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width" /> + <title>Welcome to Astro</title> +</head> + +<body> + <h1>Welcome to <a href="https://astro.build/">Astro</a></h1> +</body> + +</html> |