diff options
| -rw-r--r-- | docs/src/pages/getting-started.md | 1 | ||||
| -rw-r--r-- | docs/src/pages/installation.md | 10 | ||||
| -rw-r--r-- | docs/src/pages/quick-start.md | 2 |
3 files changed, 6 insertions, 7 deletions
diff --git a/docs/src/pages/getting-started.md b/docs/src/pages/getting-started.md index d416fff8f..d1ff80a31 100644 --- a/docs/src/pages/getting-started.md +++ b/docs/src/pages/getting-started.md @@ -1,7 +1,6 @@ --- layout: ~/layouts/Main.astro title: Getting Started - --- Astro is a modern static site builder. Learn what Astro is all about from [our homepage](https://astro.build/) or [our release post](https://astro.build/blog/introducing-astro). This page is an overview of the Astro documentation and all related resources. diff --git a/docs/src/pages/installation.md b/docs/src/pages/installation.md index 399fdf633..4fcd08f64 100644 --- a/docs/src/pages/installation.md +++ b/docs/src/pages/installation.md @@ -25,7 +25,7 @@ npm init astro yarn create astro ``` -[`create-astro`](https://github.com/snowpackjs/astro/tree/main/packages/create-astro) wizard lets you choose from a set of [starter templates](/examples) or alternatively, you could import your own Astro project directly from Github. +[`create-astro`](https://github.com/snowpackjs/astro/tree/main/packages/create-astro) wizard lets you choose from a set of [starter templates](/examples) or alternatively, you could import your own Astro project directly from Github. ```bash # Note: Replace "my-astro-project" with the name of your project. @@ -47,11 +47,12 @@ npm init astro my-astro-project -- --template [GITHUB_USER]/[REPO_NAME]/path/to/ After `create-astro` scaffolds out your project, you would need to install the projects dependencies. To do this, enter: -``` bash +```bash npm install ``` You can now [Start](#start-astro) your Astro project. Once you have completed assembling your Astro project you can then [Build](#build-astro) your project. Astro would then package up your application and have the static files ready for you to [Deploy](/guides/deploy) to your favourite hosting provider + ## Manual Install You can also setup Astro without the aide of the `create-astro` wizard, below are the few extra steps that are required to get Astro going. @@ -79,7 +80,6 @@ Astro is designed to work with the entirety of the npm package ecosystem. This i Following the instructions above, you should have a directory with a single `package.json` file inside of it. You can now setup Astro inside your project. - ```bash npm install astro ``` @@ -106,7 +106,7 @@ Astro Open up your favourite text editor, and create a new file in your project: ```astro --- -// JS/TS Code written in between the (---) code fence, +// JS/TS Code written in between the (---) code fence, // is ran solely on the Server! console.log('See me in the Terminal') --- @@ -161,4 +161,4 @@ We highly encourage you to get more familiar with the way Astro works. You can d 📚 Learn more about Astro's component syntax in our [Astro Components guide.](/core-concepts/astro-components) -📚 Learn more about Astro's file-based routing in our [Routing guide.](core-concepts/astro-pages)
\ No newline at end of file +📚 Learn more about Astro's file-based routing in our [Routing guide.](core-concepts/astro-pages) diff --git a/docs/src/pages/quick-start.md b/docs/src/pages/quick-start.md index e95a15f6a..b7855252c 100644 --- a/docs/src/pages/quick-start.md +++ b/docs/src/pages/quick-start.md @@ -67,4 +67,4 @@ We recommend that you to take some time to get more familiar with the way Astro 📚 Learn more about Astro's component syntax in our [Astro Components guide.](/core-concepts/astro-components) -📚 Learn more about Astro's file-based routing in our [Routing guide.](core-concepts/astro-pages)
\ No newline at end of file +📚 Learn more about Astro's file-based routing in our [Routing guide.](core-concepts/astro-pages) |