diff options
Diffstat (limited to '')
-rw-r--r-- | examples/astro-markdown/package.json | 8 | ||||
-rw-r--r-- | examples/blog/.gitignore (renamed from packages/create-astro/src/templates/blog/_gitignore) | 0 | ||||
-rw-r--r-- | examples/blog/README.md | 41 | ||||
-rw-r--r-- | examples/blog/astro.config.mjs | 16 | ||||
-rw-r--r-- | examples/blog/meta.json (renamed from packages/create-astro/src/templates/blog/meta.json) | 0 | ||||
-rw-r--r-- | examples/blog/package.json | 5 | ||||
-rw-r--r-- | examples/blog/public/favicon.svg (renamed from examples/doc/public/favicon.svg) | 0 | ||||
-rw-r--r-- | examples/doc/package.json | 17 | ||||
-rw-r--r-- | examples/docs/.gitignore (renamed from packages/create-astro/src/templates/starter/_gitignore) | 0 | ||||
-rw-r--r-- | examples/docs/astro.config.mjs (renamed from examples/doc/astro.config.mjs) | 0 | ||||
-rw-r--r-- | examples/docs/package.json | 15 | ||||
-rw-r--r-- | examples/docs/public/code.css (renamed from examples/doc/public/code.css) | 0 | ||||
-rw-r--r-- | examples/docs/public/favicon.svg (renamed from packages/create-astro/src/templates/blog/public/favicon.svg) | 0 | ||||
-rw-r--r-- | examples/docs/public/index.css (renamed from examples/doc/public/index.css) | 0 | ||||
-rw-r--r-- | examples/docs/public/theme.css (renamed from examples/doc/public/theme.css) | 0 | ||||
-rw-r--r-- | examples/docs/public/theme.js (renamed from examples/doc/public/theme.js) | 0 | ||||
-rw-r--r-- | examples/docs/src/components/ArticleFooter.astro (renamed from examples/doc/src/components/ArticleFooter.astro) | 0 | ||||
-rw-r--r-- | examples/docs/src/components/AvatarList.astro (renamed from examples/doc/src/components/AvatarList.astro) | 0 | ||||
-rw-r--r-- | examples/docs/src/components/DocSidebar.tsx (renamed from examples/doc/src/components/DocSidebar.tsx) | 0 | ||||
-rw-r--r-- | examples/docs/src/components/EditOnGithub.tsx (renamed from examples/doc/src/components/EditOnGithub.tsx) | 0 | ||||
-rw-r--r-- | examples/docs/src/components/Note.astro (renamed from examples/doc/src/components/Note.astro) | 0 | ||||
-rw-r--r-- | examples/docs/src/components/SiteSidebar.astro (renamed from examples/doc/src/components/SiteSidebar.astro) | 0 | ||||
-rw-r--r-- | examples/docs/src/components/ThemeToggle.tsx (renamed from examples/doc/src/components/ThemeToggle.tsx) | 0 | ||||
-rw-r--r-- | examples/docs/src/config.ts (renamed from examples/doc/src/config.ts) | 0 | ||||
-rw-r--r-- | examples/docs/src/layouts/Main.astro (renamed from examples/doc/src/layouts/Main.astro) | 0 | ||||
-rw-r--r-- | examples/docs/src/pages/example.md (renamed from examples/doc/src/pages/example.md) | 0 | ||||
-rw-r--r-- | examples/docs/src/pages/index.astro (renamed from examples/doc/src/pages/index.astro) | 0 | ||||
-rw-r--r-- | examples/kitchen-sink/package.json | 8 | ||||
-rw-r--r-- | examples/portfolio/.gitignore | 18 | ||||
-rw-r--r-- | examples/portfolio/package.json | 5 | ||||
-rw-r--r-- | examples/starter/.gitignore | 18 | ||||
-rw-r--r-- | examples/starter/README.md (renamed from packages/create-astro/src/templates/starter/README.md) | 0 | ||||
-rw-r--r-- | examples/starter/astro.config.mjs (renamed from packages/create-astro/src/templates/starter/astro.config.mjs) | 0 | ||||
-rw-r--r-- | examples/starter/meta.json (renamed from packages/create-astro/src/templates/starter/meta.json) | 0 | ||||
-rw-r--r-- | examples/starter/package.json (renamed from packages/create-astro/src/templates/blog/package.json) | 5 | ||||
-rw-r--r-- | examples/starter/public/assets/logo.svg (renamed from packages/create-astro/src/templates/starter/public/assets/logo.svg) | 0 | ||||
-rw-r--r-- | examples/starter/public/favicon.svg (renamed from packages/create-astro/src/templates/starter/public/favicon.svg) | 0 | ||||
-rw-r--r-- | examples/starter/public/robots.txt (renamed from packages/create-astro/src/templates/starter/public/robots.txt) | 0 | ||||
-rw-r--r-- | examples/starter/public/style/global.css (renamed from packages/create-astro/src/templates/starter/public/style/global.css) | 0 | ||||
-rw-r--r-- | examples/starter/public/style/home.css (renamed from packages/create-astro/src/templates/starter/public/style/home.css) | 0 | ||||
-rw-r--r-- | examples/starter/src/components/Tour.astro (renamed from packages/create-astro/src/templates/starter/src/components/Tour.astro) | 0 | ||||
-rw-r--r-- | examples/starter/src/pages/index.astro (renamed from packages/create-astro/src/templates/starter/src/pages/index.astro) | 0 | ||||
-rw-r--r-- | examples/tailwindcss/package.json | 9 |
43 files changed, 107 insertions, 58 deletions
diff --git a/examples/astro-markdown/package.json b/examples/astro-markdown/package.json index fe5cebb05..9071e0a64 100644 --- a/examples/astro-markdown/package.json +++ b/examples/astro-markdown/package.json @@ -1,15 +1,13 @@ { - "name": "@example/astro-markdown", + "name": "@astrojs/markdown-example", "version": "0.0.1", "private": true, "scripts": { "start": "astro dev", - "build": "astro build", - "astro-dev": "nodemon --delay 0.5 -w ../../packages/astro/dist -x '../../packages/astro/astro.mjs dev'" + "build": "astro build" }, "devDependencies": { - "astro": "0.12.9", - "nodemon": "^2.0.7" + "astro": "^0.12.9" }, "snowpack": { "workspaceRoot": "../.." diff --git a/packages/create-astro/src/templates/blog/_gitignore b/examples/blog/.gitignore index d436c6dad..d436c6dad 100644 --- a/packages/create-astro/src/templates/blog/_gitignore +++ b/examples/blog/.gitignore diff --git a/examples/blog/README.md b/examples/blog/README.md index 2a20654f2..87c48761c 100644 --- a/examples/blog/README.md +++ b/examples/blog/README.md @@ -1,5 +1,7 @@ # Astro Blog Example +> π§βπ **Seasoned astronaut?** Delete this file. Have fun! + Features: - β
SEO-friendly setup with canonical URLs and OpenGraph data @@ -7,24 +9,39 @@ Features: - β
RSS 2.0 generation - β
Sitemap.xml generation -## Setup +## π Project Structure + +Inside of your Astro project, you'll see the following folders and files: ``` -yarn +/ +βββ public/ +β βββ robots.txt +β βββ favicon.ico +βββ src/ +β βββ components/ +β β βββ Tour.astro +β βββ pages/ +β βββ index.astro +βββ package.json ``` -## Dev +Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name. -``` -yarn start -``` +There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components. -Preview at `http://localhost:3000` +Any static assets, like images, can be placed in the `public/` directory. -## Build +## π§ Commands -``` -yarn build -``` +All commands are run from the root of the project, from a terminal: + +| Command | Action | +|:----------------|:--------------------------------------------| +| `npm install` | Installs dependencies | +| `npm run start` | Starts local dev server at `localhost:3000` | +| `npm run build` | Build your production site to `./dist/` | + +## π Want to learn more? -Will output static site at `./dist` +Feel free to check [our documentation](https://github.com/snowpackjs/astro) or jump into our [Discord server](https://discord.gg/EsGdSGen). diff --git a/examples/blog/astro.config.mjs b/examples/blog/astro.config.mjs index 9933e9571..c7583a774 100644 --- a/examples/blog/astro.config.mjs +++ b/examples/blog/astro.config.mjs @@ -1,10 +1,14 @@ export default { - projectRoot: '.', - pages: './src/pages', - public: './public', - dist: './dist', + // projectRoot: '.', // Where to resolve all URLs relative to. Useful if you have a monorepo project. + // pages: './src/pages', // Path to Astro components, pages, and data + // dist: './dist', // When running `astro build`, path to final static output + // public: './public', // A folder of static files Astro will copy to the root. Useful for favicons, images, and other files that donβt need processing. buildOptions: { - sitemap: true, - site: 'https://mysite.dev/', // change + // site: '', // Your public domain, e.g.: https://my-site.dev/. Used to generate sitemaps and canonical URLs. + // sitemap: true, // Generate sitemap (set to "false" to disable) + }, + devOptions: { + // port: 3000, // The port to run the dev server on. + // tailwindConfig: '', // Path to tailwind.config.js if used, e.g. './tailwind.config.js' }, }; diff --git a/packages/create-astro/src/templates/blog/meta.json b/examples/blog/meta.json index caa6852e5..caa6852e5 100644 --- a/packages/create-astro/src/templates/blog/meta.json +++ b/examples/blog/meta.json diff --git a/examples/blog/package.json b/examples/blog/package.json index 5d8d17115..c6faac56a 100644 --- a/examples/blog/package.json +++ b/examples/blog/package.json @@ -1,11 +1,10 @@ { - "name": "@example/blog", + "name": "@astrojs/example-blog", "version": "0.0.1", "private": true, "scripts": { "start": "astro dev", - "build": "astro build", - "astro-dev": "nodemon --delay 0.5 -w ../../packages/astro/dist -x '../../packages/astro/astro.mjs dev'" + "build": "astro build" }, "devDependencies": { "astro": "^0.12.9", diff --git a/examples/doc/public/favicon.svg b/examples/blog/public/favicon.svg index 542f90aec..542f90aec 100644 --- a/examples/doc/public/favicon.svg +++ b/examples/blog/public/favicon.svg diff --git a/examples/doc/package.json b/examples/doc/package.json deleted file mode 100644 index 61d247ff8..000000000 --- a/examples/doc/package.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "name": "@example/doc", - "version": "0.0.1", - "private": true, - "scripts": { - "start": "astro dev", - "build": "astro build", - "astro-dev": "nodemon --delay 0.5 -w ../../packages/astro/dist -x '../../packages/astro/astro.mjs dev'" - }, - "devDependencies": { - "astro": "^0.12.9", - "nodemon": "^2.0.7" - }, - "snowpack": { - "workspaceRoot": "../.." - } -} diff --git a/packages/create-astro/src/templates/starter/_gitignore b/examples/docs/.gitignore index d436c6dad..d436c6dad 100644 --- a/packages/create-astro/src/templates/starter/_gitignore +++ b/examples/docs/.gitignore diff --git a/examples/doc/astro.config.mjs b/examples/docs/astro.config.mjs index d97e2804d..d97e2804d 100644 --- a/examples/doc/astro.config.mjs +++ b/examples/docs/astro.config.mjs diff --git a/examples/docs/package.json b/examples/docs/package.json new file mode 100644 index 000000000..cb587286d --- /dev/null +++ b/examples/docs/package.json @@ -0,0 +1,15 @@ +{ + "name": "@astrojs/docs-template", + "version": "0.0.1", + "private": true, + "scripts": { + "start": "astro dev", + "build": "astro build" + }, + "devDependencies": { + "astro": "^0.12.9" + }, + "snowpack": { + "workspaceRoot": "../.." + } +} diff --git a/examples/doc/public/code.css b/examples/docs/public/code.css index 54b2c5094..54b2c5094 100644 --- a/examples/doc/public/code.css +++ b/examples/docs/public/code.css diff --git a/packages/create-astro/src/templates/blog/public/favicon.svg b/examples/docs/public/favicon.svg index 542f90aec..542f90aec 100644 --- a/packages/create-astro/src/templates/blog/public/favicon.svg +++ b/examples/docs/public/favicon.svg diff --git a/examples/doc/public/index.css b/examples/docs/public/index.css index c5ae87f5c..c5ae87f5c 100644 --- a/examples/doc/public/index.css +++ b/examples/docs/public/index.css diff --git a/examples/doc/public/theme.css b/examples/docs/public/theme.css index d381604c8..d381604c8 100644 --- a/examples/doc/public/theme.css +++ b/examples/docs/public/theme.css diff --git a/examples/doc/public/theme.js b/examples/docs/public/theme.js index d75d0bf99..d75d0bf99 100644 --- a/examples/doc/public/theme.js +++ b/examples/docs/public/theme.js diff --git a/examples/doc/src/components/ArticleFooter.astro b/examples/docs/src/components/ArticleFooter.astro index 8078e2cc3..8078e2cc3 100644 --- a/examples/doc/src/components/ArticleFooter.astro +++ b/examples/docs/src/components/ArticleFooter.astro diff --git a/examples/doc/src/components/AvatarList.astro b/examples/docs/src/components/AvatarList.astro index aafcb371b..aafcb371b 100644 --- a/examples/doc/src/components/AvatarList.astro +++ b/examples/docs/src/components/AvatarList.astro diff --git a/examples/doc/src/components/DocSidebar.tsx b/examples/docs/src/components/DocSidebar.tsx index 076d460cc..076d460cc 100644 --- a/examples/doc/src/components/DocSidebar.tsx +++ b/examples/docs/src/components/DocSidebar.tsx diff --git a/examples/doc/src/components/EditOnGithub.tsx b/examples/docs/src/components/EditOnGithub.tsx index f7478934f..f7478934f 100644 --- a/examples/doc/src/components/EditOnGithub.tsx +++ b/examples/docs/src/components/EditOnGithub.tsx diff --git a/examples/doc/src/components/Note.astro b/examples/docs/src/components/Note.astro index 46940ddf8..46940ddf8 100644 --- a/examples/doc/src/components/Note.astro +++ b/examples/docs/src/components/Note.astro diff --git a/examples/doc/src/components/SiteSidebar.astro b/examples/docs/src/components/SiteSidebar.astro index 7279d9aea..7279d9aea 100644 --- a/examples/doc/src/components/SiteSidebar.astro +++ b/examples/docs/src/components/SiteSidebar.astro diff --git a/examples/doc/src/components/ThemeToggle.tsx b/examples/docs/src/components/ThemeToggle.tsx index 5a5061c15..5a5061c15 100644 --- a/examples/doc/src/components/ThemeToggle.tsx +++ b/examples/docs/src/components/ThemeToggle.tsx diff --git a/examples/doc/src/config.ts b/examples/docs/src/config.ts index 6b6ce3fdc..6b6ce3fdc 100644 --- a/examples/doc/src/config.ts +++ b/examples/docs/src/config.ts diff --git a/examples/doc/src/layouts/Main.astro b/examples/docs/src/layouts/Main.astro index b741098ef..b741098ef 100644 --- a/examples/doc/src/layouts/Main.astro +++ b/examples/docs/src/layouts/Main.astro diff --git a/examples/doc/src/pages/example.md b/examples/docs/src/pages/example.md index 0966595d8..0966595d8 100644 --- a/examples/doc/src/pages/example.md +++ b/examples/docs/src/pages/example.md diff --git a/examples/doc/src/pages/index.astro b/examples/docs/src/pages/index.astro index 75ca0da4f..75ca0da4f 100644 --- a/examples/doc/src/pages/index.astro +++ b/examples/docs/src/pages/index.astro diff --git a/examples/kitchen-sink/package.json b/examples/kitchen-sink/package.json index 630007124..ea89cbe3b 100644 --- a/examples/kitchen-sink/package.json +++ b/examples/kitchen-sink/package.json @@ -1,15 +1,13 @@ { - "name": "@example/kitchen-sink", + "name": "@astrojs/kitchen-sink-example", "private": true, "version": "1.0.0", "scripts": { "start": "astro dev", - "build": "astro build", - "astro-dev": "nodemon --delay 0.5 -w ../../packages/astro/dist -x '../../packages/astro/astro.mjs dev'" + "build": "astro build" }, "devDependencies": { - "astro": "^0.12.9", - "nodemon": "^2.0.7" + "astro": "^0.12.9" }, "snowpack": { "workspaceRoot": "../.." diff --git a/examples/portfolio/.gitignore b/examples/portfolio/.gitignore new file mode 100644 index 000000000..d436c6dad --- /dev/null +++ b/examples/portfolio/.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/portfolio/package.json b/examples/portfolio/package.json index 6e2ecfac6..008c624db 100644 --- a/examples/portfolio/package.json +++ b/examples/portfolio/package.json @@ -1,11 +1,10 @@ { - "name": "@example/portfolio", + "name": "@astrojs/portfolio-template", "private": true, "version": "0.0.1", "scripts": { "start": "astro dev", - "build": "astro build", - "astro-dev": "nodemon --delay 0.5 -w ../../packages/astro/dist -x '../../packages/astro/astro.mjs dev'" + "build": "astro build" }, "devDependencies": { "astro": "^0.12.9" diff --git a/examples/starter/.gitignore b/examples/starter/.gitignore new file mode 100644 index 000000000..d436c6dad --- /dev/null +++ b/examples/starter/.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/packages/create-astro/src/templates/starter/README.md b/examples/starter/README.md index 8565cdbb3..8565cdbb3 100644 --- a/packages/create-astro/src/templates/starter/README.md +++ b/examples/starter/README.md diff --git a/packages/create-astro/src/templates/starter/astro.config.mjs b/examples/starter/astro.config.mjs index e16ed1327..e16ed1327 100644 --- a/packages/create-astro/src/templates/starter/astro.config.mjs +++ b/examples/starter/astro.config.mjs diff --git a/packages/create-astro/src/templates/starter/meta.json b/examples/starter/meta.json index e9f3778c7..e9f3778c7 100644 --- a/packages/create-astro/src/templates/starter/meta.json +++ b/examples/starter/meta.json diff --git a/packages/create-astro/src/templates/blog/package.json b/examples/starter/package.json index fee6c2add..00dfc15e6 100644 --- a/packages/create-astro/src/templates/blog/package.json +++ b/examples/starter/package.json @@ -1,11 +1,12 @@ { - "name": "TODO", + "name": "@astrojs/starter-kit", "version": "0.0.1", + "private": true, "scripts": { "start": "astro dev", "build": "astro build" }, "devDependencies": { - "astro": "latest" + "astro": "^0.12.9" } } diff --git a/packages/create-astro/src/templates/starter/public/assets/logo.svg b/examples/starter/public/assets/logo.svg index d751556b2..d751556b2 100644 --- a/packages/create-astro/src/templates/starter/public/assets/logo.svg +++ b/examples/starter/public/assets/logo.svg diff --git a/packages/create-astro/src/templates/starter/public/favicon.svg b/examples/starter/public/favicon.svg index 542f90aec..542f90aec 100644 --- a/packages/create-astro/src/templates/starter/public/favicon.svg +++ b/examples/starter/public/favicon.svg diff --git a/packages/create-astro/src/templates/starter/public/robots.txt b/examples/starter/public/robots.txt index 1f53798bb..1f53798bb 100644 --- a/packages/create-astro/src/templates/starter/public/robots.txt +++ b/examples/starter/public/robots.txt diff --git a/packages/create-astro/src/templates/starter/public/style/global.css b/examples/starter/public/style/global.css index 0ce3b249a..0ce3b249a 100644 --- a/packages/create-astro/src/templates/starter/public/style/global.css +++ b/examples/starter/public/style/global.css diff --git a/packages/create-astro/src/templates/starter/public/style/home.css b/examples/starter/public/style/home.css index c4271a845..c4271a845 100644 --- a/packages/create-astro/src/templates/starter/public/style/home.css +++ b/examples/starter/public/style/home.css diff --git a/packages/create-astro/src/templates/starter/src/components/Tour.astro b/examples/starter/src/components/Tour.astro index 5c822fe75..5c822fe75 100644 --- a/packages/create-astro/src/templates/starter/src/components/Tour.astro +++ b/examples/starter/src/components/Tour.astro diff --git a/packages/create-astro/src/templates/starter/src/pages/index.astro b/examples/starter/src/pages/index.astro index de052e9c4..de052e9c4 100644 --- a/packages/create-astro/src/templates/starter/src/pages/index.astro +++ b/examples/starter/src/pages/index.astro diff --git a/examples/tailwindcss/package.json b/examples/tailwindcss/package.json index 2bea3a777..edf0cd0bd 100644 --- a/examples/tailwindcss/package.json +++ b/examples/tailwindcss/package.json @@ -1,15 +1,14 @@ { - "name": "@example/tailwindcss", + "name": "@astrojs/tailwind-example", "version": "0.0.1", "private": true, "scripts": { "start": "astro dev", - "build": "astro build", - "astro-dev": "nodemon --delay 0.5 -w ../../packages/astro/dist -x '../../packages/astro/astro.mjs dev'" + "build": "astro build" }, "devDependencies": { - "astro": "^0.12.9", - "tailwindcss": "^2.1.2" + "tailwindcss": "^2.1.2", + "astro": "^0.12.9" }, "snowpack": { "workspaceRoot": "../.." |