Skip to content

Commit

Permalink
Merge pull request withastro#196 from jose8a/patch-2
Browse files Browse the repository at this point in the history
Update the manual-setup.md instructions
  • Loading branch information
sarah11918 authored Mar 14, 2022
2 parents 93fe0af + 04c94b8 commit 25fc7f6
Showing 1 changed file with 32 additions and 9 deletions.
41 changes: 32 additions & 9 deletions src/pages/en/guides/manual-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ Then, replace any placeholder "scripts" section of your `package.json` with the
```

You'll use these scripts later in the guide to start Astro and run its different commands.

## 3. Create your first page

In your text editor, create a new file in your directory at `src/pages/index.astro`. This will be your first Astro page in the project.
Expand Down Expand Up @@ -82,19 +83,41 @@ User-agent: *
Allow: /
```

## 5. Next steps
## 5. Create astro.config.mjs

Astro is configured using `astro.config.mjs`. This file is optional if you do not need to configure Astro, but you may wish to create it now.

Create `astro.config.mjs` at the root of your project, and copy the code below into it:

```
// Full Astro Configuration API Documentation:
// https://docs.astro.build/reference/configuration-reference
// @ts-check
export default /** @type {import('astro').AstroUserConfig} */ ({
// Comment out "renderers: []" to enable Astro's default component support.
renderers: [],
});
```

If you want to include framework components such as React, Svelte, etc. in your project, here is where you will [manually add any necessary renderers](/en/core-concepts/framework-components/#customize-your-frameworks).

πŸ“š Read Astro's [API configuration reference](/en/reference/configuration-reference/) for more information.

## 6. Next steps

If you have followed the steps above, your project directory should now look like this:

```
- src/
- pages/
- index.astro
- public/
- robots.txt
- package.json
- package-lock.json (or: yarn.lock, pnpm-lock.yaml, etc.)
- node_modules/
β”œβ”€β”€ node_modules/
β”œβ”€β”€ src/
β”‚ └── pages/
β”‚ β”‚ └── index.astro
β”œβ”€β”€ public/
β”‚ β”œβ”€β”€ robots.txt
β”œβ”€β”€ astro.config.mjs
β”œβ”€β”€ package.json
└── package-lock.json (or: yarn.lock, pnpm-lock.yaml, etc.)
```

Congratulations, you're now set up to use Astro!
Expand Down

0 comments on commit 25fc7f6

Please sign in to comment.