Skip to content

Latest commit

 

History

History
103 lines (81 loc) · 5.77 KB

README.md

File metadata and controls

103 lines (81 loc) · 5.77 KB

Gatsby

Gatsby Starters

⚛️ 📄 🚀

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. PRs welcome!

Gatsby is a modern framework for blazing fast websites. This repository is our monorepo for managing all the great GatsbyJS starters for the community.

What's a starter?

A starter is a simplified example to get up and running with Gatsby quickly and easily. These starters are directly integrated with the Gatsby Command Line Interface (CLI).

Official Starters

Name Demo Description
blog gatsby-starter-blog-demo.netlify.com A starter for a blog powered by Gatsby and Markdown
default gatsby-starter-default-demo.netlify.com A simple starter to get up and developing quickly with Gatsby
hello-world gatsby-starter-hello-world-demo.netlify.com A simplified bare-bones starter for Gatsby

🚀 Get Up and Running in 5 Minutes

# create a new Gatsby site using the default starter
gatsby new my-blazing-fast-site

e.g. gatsby new my-blazing-fast-site https://github.com/gatsbyjs/gatsby-starter-blog or gatsby new my-blazing-fast-site https://github.com/gatsbyjs/gatsby-starter-hello-world to use a specific starter!

This will clone the starter of specified name into the folder my-blazing-fast-site and get you up and running in under 5 minutes with Gatsby and a fantastic starter. We can't wait to see what you build!

🤝 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--starters!!-- managed in this codebase that are independently versioned but co-exist within this repository.

We have set-up read-only clones of all of the starters in the official gatsbyjs organization. For example, the default starter is available as a read-only clone at gatsbyjs/gatsby-starter-default. Please open PRs versus this repository rather than the read-only clones. Upon merge any starters that have been modified will be tagged and released.