The Gatsby CLI tool lets you install “starters”. These are boilerplate Gatsby sites maintained by the community.
gatsby new helps you start your project by cloning the boilerplate, installing dependencies, and clearing Git history.
When creating a new site, you can optionally specify a starter to base your new site on, either with the
[URL] of the
gatsby new [SITE_DIRECTORY] [URL_OF_STARTER_GITHUB_REPO]
gatsby new [SITE_DIRECTORY] [GIT_USER_NAME/REPO]
For example, to quickly create a blog using Gatsby, you could install the Gatsby Starter Blog by running:
gatsby new blog https://github.com/gatsbyjs/gatsby-starter-blog
This downloads the files and initializes the site by running
Or, you can use the
gatsby new blog gatsbyjs/gatsby-starter-blog
If you don’t specify a custom starter, your site will be created from the default starter.
Learn how to make a starter in the Gatsby docs. Starters can be created for your team(s) only, or distributed to the broader community. It’s up to you!
Official starters are maintained by Gatsby.
Community starters are created and maintained by Gatsby community members.
Looking for a starter for a particular use case? Peruse starters that have been submitted to the Starter Library
Created a starter you’d like to share? Follow these steps to submit your starter to the Starter Library.
Edit this page on GitHub