Permalink
Switch branches/tags
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
371 lines (332 sloc) 26.2 KB

Travis CI Build Status npm package npm package Join the community on Spectrum gatsby channel on discord Open Source Helpers Twitter Follow

Gatsby

Gatsby v2 Beta

⚛️📄🚀 Blazing-fast site generator for React

NOTE: This branch is the beta version of Gatsby v2. You can find documentation at next.gatsbyjs.org.

For gatsby@1, please see the v1 branch.

Are you using v1 and want to upgrade to the Gatsby v2 Beta? Check out our v1 => v2 migration guide.

Starting a new project with Gatsby v2 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.

gatsby-starter-default with v2:

gatsby new my-default-project https://github.com/gatsbyjs/gatsby-starter-default#v2

gatsby-starter-hello-world with v2:

gatsby new my-hello-world https://github.com/gatsbyjs/gatsby-starter-hello-world#v2

gatsby-starter-blog with v2:

gatsby new my-blog https://github.com/gatsbyjs/gatsby-starter-blog#v2

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

How are pull requests being handled during the v2 beta?

The following policy will be in place during the v2 beta:

  • We will only accept bug fixes for Gatsby v1. Any PRs opened against v1 that are not bug fixes will be closed

  • If the bug fix is applicable to v2, we will open an additional issue to track porting the change to v2

  • All new features should be opened as pull requests against v2 (the master branch)

We're using this policy as the Gatsby team currently spends a significant amount of time maintaining two active branches - the v1 branch and the v2 branch - we'd like to limit this work to focus on getting v2 released and start working on oft-requested new features like schema snapshots and schema stitching.

Showcase

Websites built with Gatsby:

Docs

View the docs on gatsbyjs.org

Migrating from v1 to v2?

Migrating from v0 to v1?

v0 docs

Packages

This repository is a monorepo managed using Lerna. This means that we publish many packages to NPM from the same codebase.

Thanks

Thanks to our many contributors and sponsors as well as the companies sponsoring our testing and hosting infrastructure, Travis CI, Appveyor, and Netlify.

Backers

Support us with a monthly donation and help us continue our activities. [Become a backer]

Sponsors

Become a sponsor and get your logo on our README on GitHub with a link to your site. [Become a sponsor]