-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Request Review #76
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Request Review #76
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
af0b87a
Fixed an error targeting the scroll el
aFuzzyBear ed6294d
fixed a bug in the script
aFuzzyBear b13322d
fixed a bug in the script
aFuzzyBear 75ab440
Made the docs site mobile friendly
aFuzzyBear a49ee10
Minor style changes
aFuzzyBear dbc98f6
Made ammendments as requested
aFuzzyBear File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
--- | ||
layout: ~/layouts/Main.astro | ||
title: Getting Started | ||
--- | ||
<!-- Attempt to get the Starting page right, --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,58 +3,67 @@ layout: ~/layouts/Main.astro | |
title: Installation | ||
--- | ||
|
||
There are a few different ways to install | ||
There are a few ways to get started with Astro. Outlined below are instructions on how to go about installing Astro either manually or by using our Astro Installer. | ||
|
||
## Prerequisites | ||
## System Requirements | ||
|
||
- **Node.js** - `v12.20.0`, `v14.13.1`, `v16.0.0`, or higher. | ||
- **A text editor** - We recommend [VS Code](https://code.visualstudio.com/) with the [Astro extension](https://marketplace.visualstudio.com/items?itemName=astro-build.astro-vscode). | ||
- **A terminal** - Astro is mainly accessed by terminal command-line. | ||
- **Node.js** - [`v12.20.0`](https://nodejs.org/en/download/releases/), [`v14.13.1`](https://nodejs.org/en/download/),[ `v16.0.0`](https://nodejs.org/en/download/current/), or higher. | ||
- **A text editor** - We recommend [VS Code](https://code.visualstudio.com/) with our own [Astro extension](https://marketplace.visualstudio.com/items?itemName=astro-build.astro-vscode) for the complete Developer Experience. | ||
- **A terminal** - Astro is mainly accessed by the terminal's Command Line Interface (CLI). | ||
|
||
## Recommended Install | ||
## Astro Installer | ||
<!-- Feels like this needed stronger prominence in the text than it had previously --> | ||
```bash | ||
npm init astro | ||
``` | ||
|
||
`npm init astro` is the easiest way to install Astro in a new project. Run this command in your terminal to start our `create-astro` install wizard to walk you through setting up a new project. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. your a wizard harry, |
||
Run this command in your terminal to start our `create-astro` Installer. Letting you walk through setting up a new Astro project. | ||
|
||
```bash | ||
mkdir <project-name> | ||
cd <project-name> | ||
npm init astro | ||
``` | ||
|
||
Follow the CLI instructions to install Astro with one of our official project starter templates. | ||
Follow along with the CLI instructions to install Astro with one of our official project starter templates. | ||
|
||
Once completed, jump over to our [Quickstart Guide](/quick-start#start-your-project) for a 30-second walkthrough on how to start & build your new Astro project! | ||
Once completed, jump over to our [QuickStart Guide](/quick-start#start-your-project) for a walk-through on how to **Start & Build** your new Astro project! | ||
|
||
## Manual Install | ||
|
||
You can install Astro without the aide of the Astro Installer. Below demonstrates the best way to go about starting your project | ||
|
||
### Set up your project | ||
|
||
Create an empty directory with the name of your project, and then navigate into it: | ||
|
||
```bash | ||
# Note: Replace <project-name> with the name of your project. | ||
mkdir <project-name> | ||
cd <project-name> | ||
# Note: Replace <project-name> with the name of your project. | ||
``` | ||
|
||
Create a new `package.json` file for your project. Astro is designed to work with the npm ecosystem of packages, which is managed in a `package.json` project manifest. If you don't know what the `package.json` file is, we highly recommend you to have a quick read on [the npm documentation](https://docs.npmjs.com/creating-a-package-json-file). | ||
Astro is designed to work with the entire [npm](https://www.npmjs.com/) ecosystem, which is managed by the `package.json` project manifest. | ||
|
||
To create a new [`package.json`](https://docs.npmjs.com/creating-a-package-json-file)file for your project, run the following command: | ||
|
||
```bash | ||
# This command will create a basic package.json for you | ||
npm init --yes | ||
``` | ||
|
||
### Install Astro | ||
Once your project is setup, you should have a directory with a single `package.json` file inside of it. You can now install Astro in your project. | ||
|
||
If you've followed the instructions above, you should have a directory with a single `package.json` file inside of it. You can now install Astro in your project. | ||
We use [`npm`](https://www.npmjs.com/) in the examples below, but you could also use [`yarn`](https://yarnpkg.com/) or [`pnpm`](https://pnpm.io/) if you prefer an npm alternative. If you're not familiar with either `yarn` or `pnpm`, then we highly recommend sticking with `npm`. | ||
aFuzzyBear marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
We'll use `npm` in the examples below, but you could also use `yarn` or `pnpm` if you prefer an npm alternative. If you aren't familiar with `yarn` or `pnpm`, then we strongly recommend sticking with `npm`. | ||
### Install Astro | ||
|
||
```bash | ||
npm install astro | ||
``` | ||
|
||
You can now replace the placeholder "scripts" section of your `package.json` file that `npm init` created for you with the following: | ||
This command pulls Astro from the npm registry and saves this as a direct(?) dependency in your project manifest. | ||
|
||
To use Astro add the following, within the "scripts" section of your `package.json` file. | ||
|
||
```diff | ||
"scripts": { | ||
|
@@ -65,14 +74,16 @@ You can now replace the placeholder "scripts" section of your `package.json` fil | |
} | ||
``` | ||
|
||
You can [configure](/reference/configuration-reference.md) you Astro Project further to work with your preferred type of (UI Framework)/ or Style System | ||
|
||
### Create your first page | ||
|
||
Open up your favorite text editor, and create a new file in your project: | ||
Open up your favourite text editor, and create a new file inside your project: | ||
|
||
```astro | ||
--- | ||
// 1. Create a new file at <project-directory>/src/pages/index.astro | ||
// 2. Copy-and-paste this entire file (including `-` dashes) into it. | ||
// 2. Copy-and-paste this entire file (including `---` dashes) into it. | ||
--- | ||
<html> | ||
<body> | ||
|
@@ -85,9 +96,8 @@ You can create more pages in the `src/pages` directory, and Astro will use the f | |
|
||
### Next Steps | ||
|
||
Success! You're now ready to start developing! Jump over to our [Quickstart Guide](/quick-start#start-your-project) for a 30-second walkthrough on how to start & build your new Astro project! | ||
Success! You're now ready to start developing! Jump over to our [Quickstart Guide](/quick-start#start-your-project) for a 30-second walk-through on how to start & build your new Astro project! | ||
|
||
📚 Learn more about Astro's project structure in our [Project Structure guide](/core-concepts/project-structure). | ||
📚 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). | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"walkthrough" is a double barrell word, "walk-through"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! 🎉