Skip to content

Commit c792635

Browse files
committed
update the readme
1 parent 6dc1650 commit c792635

File tree

1 file changed

+26
-23
lines changed

1 file changed

+26
-23
lines changed

README.md

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -24,40 +24,43 @@
2424

2525
This site is created with Gatsby.
2626

27-
1. **Prerequisites**
27+
### Prerequisites
2828

29-
Minimal node version: See the [`.nvmrc` file](.nvmrc).
29+
Minimal node version: See the [`.nvmrc` file](.nvmrc).
3030

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

34+
### Start developing
3435

35-
2. **Start developing**
36+
#### Install dependencies
37+
```shell
38+
npm install
39+
```
3640

37-
Install dependencies.
38-
```shell
39-
npm install
40-
```
41-
42-
Start the development server
43-
```shell
41+
#### Start the development server
42+
```shell
4443
npm start
45-
```
44+
```
45+
46+
Your site is now running at http://localhost:8000! \
47+
You can modify a file from `src` to see your site update in real-time!
48+
49+
## Pull Request Previews
50+
51+
In Pull Request, a preview is generated to see how the modified website will look.
4652

47-
Your site is now running at http://localhost:8000! \
48-
You can modify a file from `src` to see your site update in real-time!
49-
53+
## Learn more
5054

51-
3. **Learn more**
55+
- [Documentation](https://www.gatsbyjs.com/docs/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
5256

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

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

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

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

61-
- [Plugin Library](https://www.gatsbyjs.com/plugins?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
65+
- [Cheat Sheet](https://www.gatsbyjs.com/docs/cheat-sheet/?utm_source=starter&utm_medium=readme&utm_campaign=minimal-starter)
6266

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

0 commit comments

Comments
 (0)