From 0ce13fb43ff3c23b4c038b76984f6fb54cc29b3b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Souchet=20C=C3=A9line?= Date: Tue, 28 Jan 2025 14:22:59 +0100 Subject: [PATCH] update the readme --- README.md | 49 ++++++++++++++++++++++++++----------------------- 1 file changed, 26 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index 6d984dff0..368331615 100644 --- a/README.md +++ b/README.md @@ -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)