Skip to content

Commit

Permalink
docs: update the readme (#1385)
Browse files Browse the repository at this point in the history
  • Loading branch information
csouchet authored Jan 28, 2025
1 parent 6dc1650 commit 551da1f
Showing 1 changed file with 26 additions and 23 deletions.
49 changes: 26 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,40 +24,43 @@

This site is created with Gatsby.

1. **Prerequisites**
### Prerequisites

Minimal node version: See the [`.nvmrc` file](.nvmrc).
Minimal node version: See the [`.nvmrc` file](.nvmrc).

If you use `nvm`, you can change the node version used locally with `nvm use`. \
It loads the version specified in the `.nvmrc` file.
If you use `nvm`, you can change the node version used locally with `nvm use`. \
It loads the version specified in the `.nvmrc` file.

### Start developing

2. **Start developing**
#### Install dependencies
```shell
npm install
```

Install dependencies.
```shell
npm install
```
#### Start the development server
```shell
npm start
```

Start the development server
```shell
npm start
```
Your site is now running at http://localhost:8000! \
You can modify a file from `src` to see your site update in real-time!

Your site is now running at http://localhost:8000! \
You can modify a file from `src` to see your site update in real-time!

## Pull Request Previews

3. **Learn more**
In Pull Request, a preview is generated to see how the modified website will look.

- [Documentation](https://www.gatsbyjs.com/docs/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
## Learn more

- [Tutorials](https://www.gatsbyjs.com/tutorial/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
- [Documentation](https://www.gatsbyjs.com/docs/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)

- [Guides](https://www.gatsbyjs.com/tutorial/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
- [Tutorials](https://www.gatsbyjs.com/tutorial/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)

- [API Reference](https://www.gatsbyjs.com/docs/api-reference/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
- [Guides](https://www.gatsbyjs.com/tutorial/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)

- [Plugin Library](https://www.gatsbyjs.com/plugins?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
- [API Reference](https://www.gatsbyjs.com/docs/api-reference/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)

- [Plugin Library](https://www.gatsbyjs.com/plugins?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)

- [Cheat Sheet](https://www.gatsbyjs.com/docs/cheat-sheet/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)

- [Cheat Sheet](https://www.gatsbyjs.com/docs/cheat-sheet/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)

0 comments on commit 551da1f

Please sign in to comment.