Skip to content

Latest commit

 

History

History
51 lines (36 loc) · 2.3 KB

getting-started.md

File metadata and controls

51 lines (36 loc) · 2.3 KB

Getting Started

Pre-Requisites

Python v2 is required to install Gatsby. Please ensure python is in your PATH.

Install

npm install -g gatsby

Create a new site from scratch

  1. Create new Gatsby site gatsby new my-test-gatsby-site This creates the directory for your Gatsby project and adds the minimal files needed.
  2. cd my-test-gatsby-site
  3. gatsby develop — Gatsby will start a hot-reloading development server accessible at localhost:8000

Create a new site from a Gatsby Starter

The Gatsby CLI tool lets you install "starters". These are partially built sites preconfigured to help you get moving faster on creating a certain type of site.

When creating a new site, you can optionally specify a starter to base your new site on e.g. gatsby new [SITE_DIRECTORY] [URL_OF_STARTER]

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 npm install

If you don't specify a custom starter, your site will be created from the default starter.

There are several starters that have been created. Create a PR to include yours!