The Gatsby CLI tool lets you install starters, which are boilerplate Gatsby sites maintained by the community and intended for jump-starting development quickly.
gatsby new command to clone a boilerplate starter, install its dependencies, and clear Git history.
Using Git repo URLs
When creating a new Gatsby site, you can optionally specify a starter to base your new site on; they can come from any publicly available Git repo, such as GitHub, GitLab, or Bitbucket. You can supply the
For example, to create a site in a
blog directory with Gatsby Starter Blog from its GitHub URL:
This downloads the files and initializes the site by running
Using GitHub usernames and repos instead of URLs
Alternatively, you can also supply a GitHub username and repository:
Here is an example with the
This also downloads the files and initializes the site by running
If you don’t specify a custom starter, your site will be created from the default starter.
Note: If you work for an Enterprise-level company where you are unable to pull from public GitHub repositories, you can still set up Gatsby. Check out the docs to learn more.
Using a local starter
Another option is to supply a path (relative or absolute) to a local folder containing a starter:
Here is an example assuming a starter exists on the path
Official starters are maintained by Gatsby.
|gatsby-starter-default||Demo||Appropriate for most use cases||General Gatsby site|
|gatsby-starter-blog||Demo||Create a basic blog||Blog post pages and listings|
|gatsby-starter-hello-world||Demo||Learn Gatsby||Gatsby bare essentials|
|gatsby-starter-blog-theme||Docs||Blog posts and pages||Gatsby themes|
|gatsby-starter-theme-workspace||Docs||Building Gatsby Themes||Minimal theme workspace|
|gatsby-starter-rendering-modes||Demo||Learn different rendering modes||DSG and SSR|
|gatsby-starter-wordpress-blog||Demo||WordPress blog post pages and listings||WordPress integration|
|gatsby-starter-landing-page||Demo||Dynamic marketing landing pages||Contentful integration|
|gatsby-starter-homepage-contentful||Demo||Homepage template||Contentful integration|
|gatsby-starter-homepage-wordpress||Demo||Homepage template||WordPress integration|
|gatsby-starter-homepage-drupal||Demo||Homepage template||Drupal integration|
|gatsby-starter-homepage-datocms||Demo||Homepage template||DatoCMS integration|
|gatsby-starter-homepage-sanity||Demo||Homepage template||Sanity integration|
Learn how to modify a starter in the Gatsby docs. You can use official and community starters out of the box but you may want to customize their style and functionality.
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!
Community starters are created and maintained by Gatsby community members.
- Looking for a starter for a particular use case? Browse starters that have been submitted to the Starter Library.
- Have you built your own starter? Submit it for review to share it with the community by having it featured in the Gatsby Starter Library.