Skip to content

Commit 395269d

Browse files
m-allansonKyleAMathews
authored andcommitted
v2 starter docs (#6070)
* Remove double 'each' * Add info about v2 starters to the quick start section of the docs * Add info about the v2 starters to the readme * Shorten copy and use consistent capitalisation on v1 and v2
1 parent b11b354 commit 395269d

File tree

3 files changed

+51
-6
lines changed

3 files changed

+51
-6
lines changed

README.md

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,38 @@
88

99
<img alt="Gatsby" src="https://www.gatsbyjs.org/monogram.svg" width="100">
1010

11-
# Gatsby V2 Beta
11+
# Gatsby v2 Beta
1212

1313
⚛️📄🚀 Blazing-fast site generator for React
1414

15-
**NOTE:** This branch is the beta version of Gatsby V2. You can find documentation at [next.gatsbyjs.org](https://next.gatsbyjs.org/).
15+
**NOTE:** This branch is the beta version of Gatsby v2. You can find documentation at [next.gatsbyjs.org](https://next.gatsbyjs.org/).
1616

1717
For `gatsby@1`, please see [the v1 branch](https://github.com/gatsbyjs/gatsby/tree/v1).
1818

19-
**Are you using V1 and want to try upgrading and help prepare Gatsby for v2? Check out [our V1 => V2 migration guide](https://next.gatsbyjs.org/docs/migrating-from-v1-to-v2/).**
19+
**Are you using v1 and want to upgrade to the Gatsby v2 Beta? Check out [our v1 => v2 migration guide](https://next.gatsbyjs.org/docs/migrating-from-v1-to-v2/).**
20+
21+
**Starting a new project with Gatsby v2**
22+
If you'd like to start a new project with Gatsby v2 you can use the v2 edition of any offical starter. Install your favourite one with the Gatsby CLI.
23+
24+
`gatsby-starter-default` with v2:
25+
26+
```
27+
gatsby new my-default-project https://github.com/gatsbyjs/gatsby-starter-default#v2
28+
```
29+
30+
`gatsby-starter-hello-world` with v2:
31+
32+
```
33+
gatsby new my-hello-world https://github.com/gatsbyjs/gatsby-starter-hello-world#v2
34+
```
35+
36+
`gatsby-starter-blog` with v2:
37+
38+
```
39+
gatsby new my-blog https://github.com/gatsbyjs/gatsby-starter-blog#v2
40+
```
41+
42+
If you're a _start from scratch_ kind of person, you can install the Gatsby beta and React like this: `npm install gatsby@next react react-dom`
2043

2144
**How are pull requests being handled during the v2 beta?**
2245

docs/docs/gatsby-starters.md

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ If you don't specify a custom starter, your site will be created from the
2222

2323
There are several starters that have been created. Create a PR to include yours!
2424

25-
Official:
25+
## Official starters
2626

2727
- [gatsby-starter-default](https://github.com/gatsbyjs/gatsby-starter-default)
2828
[(demo)](http://gatsbyjs.github.io/gatsby-starter-default/)
@@ -31,7 +31,29 @@ Official:
3131
- [gatsby-starter-hello-world](https://github.com/gatsbyjs/gatsby-starter-hello-world)
3232
[(demo)](https://aberrant-fifth.surge.sh/)
3333

34-
Community:
34+
### Using Gatsby v2 with the official starters
35+
36+
If you'd like to get started with Gatsby v2 you're in luck, there's a v2 edition for each of the offical starters. Install your favourite one with the Gatsby CLI.
37+
38+
`gatsby-starter-default` with v2:
39+
40+
```
41+
gatsby new my-default-project https://github.com/gatsbyjs/gatsby-starter-default#v2
42+
```
43+
44+
`gatsby-starter-hello-world` with v2:
45+
46+
```
47+
gatsby new my-hello-world https://github.com/gatsbyjs/gatsby-starter-hello-world#v2
48+
```
49+
50+
`gatsby-starter-blog` with v2:
51+
52+
```
53+
gatsby new my-blog https://github.com/gatsbyjs/gatsby-starter-blog#v2
54+
```
55+
56+
## Community starters
3557

3658
- [gatsby-starter-blog-no-styles](https://github.com/noahg/gatsby-starter-blog-no-styles)
3759
[(demo)](http://capricious-spring.surge.sh/)

docs/docs/migrating-from-v1-to-v2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Before diving in to the upgrade guide, here's a brief section on starting a new
1414

1515
If you're a _start from scratch_ kind of person, you can install the Gatsby beta and React like this: `npm install gatsby@next react react-dom`
1616

17-
If you'd rather use one of the official starters, you're in luck, there's a v2 edition for each of them. You can install each one using the Gatsby CLI.
17+
If you'd rather use one of the official starters, you're in luck, there's a v2 edition for each of them. Install your favourite one with the Gatsby CLI.
1818

1919
`gatsby-starter-default` with v2:
2020

0 commit comments

Comments
 (0)