Build blazing fast, modern apps and websites with React
Switch branches/tags
AnushPatel-patch-1 JanoshRiebesell-patch-1 KyleAMathews-patch-1 Partner-program add-depn add-escalade-sports-case-study add-mobile-performance-post add-plugin-documentation alter-blog-post-date amberleyromo-7730-starter-showcase-sourcing amberleyromo-patch-1 array-doclets berrak-responsive-layout blogpost-gatsby-days-preso calcsam-patch-1 ccustom-algolia-index change-hacktoberfest-title config-api coreyward-patch-1-1 cypress-timeouts docs-rename-starter docs/gatsby-remark-images-sharp documentation-project-blogpost-new-title drop-alpha-support filter-css fix-broken-link fix-doc fix-docs-reload fix/starter-detail-dependency-grid fix/typescript-reach-router fixes-to-plugin-library gatsby-ssr-silent-fail graphql-filter-sort gvarandas-patch-1 hu0p-patch-1 imagentleman-patch-1 link-container m-allanson-patch-1 marisamorby-swag-store-post master mikeriley131-patch-1 neo/move-prefixPath old-master-3 old-master-4 old-master-6 old-master-7 page-metadata-splitting plugin-blogpost-edit plugin-cli pr/8963 revert-4254-blog-documentation-project revert-5047-update-remark revert-workspaces rfbotto-patch-1 sample-branch-example sebastienfi-wp-orderby-date-asc shannonbux-docs-contributions sharp-images-no-ext sort-chunks starterShowcase2 style-guide-update styled-components-babelrc-config-doc test-builds topics/gatsby-plugin-sharp-tracesvg-fluid topics/inconsistent-accordian-behavior-docs-sidebar topics/using-gatsby-image-design-refresh topics/www-bump-remark-autolink-headers topics/www-sidebar-move-expand-all-down tryzniak-patch-1 update-imagemin-deps updated-style-guide-tutorial-details v1 v2 valse-disable-default-pageview valse-resolve-env worker
Nothing to show
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci fix(ci): actually only run tests on non-docs changes (#10287) Dec 4, 2018
.github fix typo in pull request template (#10454) Dec 13, 2018
benchmarks chore(gatsby): remove unused nyc dependency (#10063) Nov 21, 2018
docs fix(docs): window.reload => window.location.reload (#10459) Dec 15, 2018
e2e-tests feat(prefetch): add support for effective-connection-type & saveData (#… Dec 11, 2018
examples docs: migrated line highlighting to highlight-line, highlight-start, … Dec 7, 2018
flow-typed chore(gatsby): remove unused nyc dependency (#10063) Nov 21, 2018
infrastructure Revert "Topics/output dir (#4756)" May 31, 2018
integration-tests refactor(ci): move cypress tests to e2e-tests directory; update circl… Oct 15, 2018
packages fix(gatsby-plugin-offline): prevent incorrect revisioning of static f… Dec 13, 2018
plop-templates chore: implement babel-preset-gatsby into packages that need it (#9323) Oct 29, 2018
scripts plugin checker initial commit (#7062) Dec 7, 2018
translations/es docs: migrated line highlighting to highlight-line, highlight-start, … Dec 7, 2018
www feat(www): add unbird feedback component to starter lib (#10450) Dec 14, 2018
.babelrc.js chore: implement babel-preset-gatsby into packages that need it (#9323) Oct 29, 2018
.dockerignore [v2] WIP merge in master (#4061) Feb 15, 2018
.editorconfig chore: add git hooks and simplify scripts (#8427) Nov 6, 2018
.eslintrc.json fix(gatsby): don't remount matchPath pages (#10261) Dec 5, 2018
.flowconfig Merge v2 in master making it the default branch (#5954) Jun 17, 2018
.gitattributes fix: linting check on azure/appveyor (#9781) Nov 7, 2018
.gitignore ci: produce jest xml reports only in azure pipelines (#10160) Nov 27, 2018
.prettierignore fix(prettier): ignore coverage directory (#10064) Nov 21, 2018
.prettierrc chore: add git hooks and simplify scripts (#8427) Nov 6, 2018
.yarnrc clean up dup packages and use yarn as client (#1939) Aug 30, 2017 fix: linting check on azure/appveyor (#9781) Nov 7, 2018
CODEOWNERS feat(www): Rename community section to creators (#10312) Dec 6, 2018 [v2] merge master into v2 (#5451) May 17, 2018
Dockerfile Skip libvips and builds tools as sharp v0.20.0 now downloads binaries ( Mar 5, 2018
LICENSE Update copyright Mar 28, 2016 Add license internal link (#10143) Nov 26, 2018
appveyor.yml chore: format YAML files with Prettier (#8407) Sep 25, 2018
azure-pipelines.yml ci: produce jest xml reports only in azure pipelines (#10160) Nov 27, 2018
jest-transformer.js chore: implement babel-preset-gatsby into packages that need it (#9323) Oct 29, 2018
jest.config.js ci: produce jest xml reports only in azure pipelines (#10160) Nov 27, 2018
junit.xml docs: migrated line highlighting to highlight-line, highlight-start, … Dec 7, 2018
lerna.json Specify npm as the registry so that lerna's auth checks work (#8258) Sep 18, 2018
netlify.toml arg (#2747) Nov 2, 2017
package.json ci: produce jest xml reports only in azure pipelines (#10160) Nov 27, 2018
plopfile.js chore: Format JS Files (#8623) Nov 6, 2018
yarn.lock fix(gatsby): fix extracting StaticQuery nested in shorthand fragment (#… Dec 13, 2018


Gatsby v2

⚛️ 📄 🚀

Blazing fast modern site generator for React
Go beyond static sites: build blogs, e-commerce sites, full-blown apps, and more with Gatsby.

Gatsby is released under the MIT license. Current CircleCI build status. Current npm package version. Downloads per month on npm. Total downloads on npm. PRs welcome!

Quickstart · Tutorial · Plugins · Starters · Showcase · Contribute · Support: Spectrum & Discord

Gatsby is a modern framework for blazing fast websites.

  • Go Beyond Static Websites. Get all the benefits of static websites with none of the limitations. Gatsby sites are fully functional React apps so you can create high-quality, dynamic web apps, from blogs to e-commerce sites to user dashboards.

  • Use a Modern Stack for Every Site. No matter where the data comes from, Gatsby sites are built using React and GraphQL. Build a uniform workflow for you and your team, regardless of whether the data is coming from the same back-end.

  • Load Data From Anywhere. Gatsby pulls in data from any data source, whether it’s Markdown files, a headless CMS like Contentful or WordPress, or a REST or GraphQL API. Use source plugins to load your data, then develop using Gatsby’s uniform GraphQL interface.

  • Performance Is Baked In. Ace your performance audits by default. Gatsby automates code splitting, image optimization, inlining critical styles, lazy-loading, and prefetching resources, and more to ensure your site is fast — no manual tuning required.

  • Host at Scale for Pennies. Gatsby sites don’t require servers so you can host your entire site on a CDN for a fraction of the cost of a server-rendered site. Many Gatsby sites can be hosted entirely free on services like GitHub Pages and Netlify.

Learn how to use Gatsby for your next project.

What’s In This Document

🚀 Get Up and Running in 5 Minutes

You can get a new Gatsby site up and running on your local dev environment in 5 minutes with these three steps:

  1. Create a Gatsby site from a Gatsby starter.

    Get your Gatsby blog set up in a single command:

    # install the Gatsby CLI globally
    npm install -g gatsby-cli
    # create a new Gatsby site using the default starter
    gatsby new my-blazing-fast-site
  2. Start the site in develop mode.

    Next, move into your new site’s directory and start it up:

    cd my-blazing-fast-site/
    gatsby develop
  3. Open the source code and start editing!

    Your site is now running at http://localhost:8000. Open the my-blazing-fast-site directory in your code editor of choice and edit src/pages/index.js. Save your changes, and the browser will update in real time!

At this point, you’ve got a fully functional Gatsby website. For additional information on how you can customize your Gatsby site, see our plugins and the official tutorial.

🎓 Learning Gatsby

Full documentation for Gatsby lives on the website.

  • For most developers, we recommend starting with our in-depth tutorial for creating a site with Gatsby. It starts with zero assumptions about your level of ability and walks through every step of the process.

  • To dive straight into code samples head to our documentation. In particular, check out the “Guides”, “API Reference”, and “Advanced Tutorials” sections in the sidebar.

We welcome suggestions for improving our docs. See the “how to contribute” documentation for more details.

Start Learning Gatsby: Follow the Tutorial · Read the Docs

💼 Migration Guides

Already have a Gatsby site? These handy guides will help you add the improvements of Gatsby v2 to your site without starting from scratch!

🤝 How to Contribute

Whether you're helping us fix bugs, improve the docs, or spread the word, we'd love to have you as part of the Gatsby community! 💪💜

Check out our Contributing Guide for ideas on contributing and setup steps for getting our repositories up and running on your local machine.

Code of Conduct

Gatsby is dedicated to building a welcoming, diverse, safe community. We expect everyone participating in the Gatsby community to abide by our Code of Conduct. Please read it. Please follow it. In the Gatsby community, we work hard to build each other up and create amazing things together. 💪💜

A note on how this repository is organized

This repository is a monorepo managed using Lerna. This means there are multiple packages managed in this codebase, even though we publish them to NPM as separate packages.

Contributing to Gatsby v1

We are currently only accepting bug fixes for Gatsby v1. No new features will be accepted.

📝 License

Licensed under the MIT License.

💜 Thanks to Our Contributors and Sponsors

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