Scribd
Upload
161 views2 pages

Gatsby Cheat Sheet

This document provides commands and definitions for using Gatsby. It lists commands to install Gatsby CLI, create new sites, develop sites, build sites for deployment, and clean caches. It also defines important files used in Gatsby projects like gatsby-config.js, gatsby-node.js, gatsby-browser.js, and gatsby-ssr.js. Quick start commands are provided to create a new site from a starter.

Uploaded by

Gonzalo Sidney
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
161 views2 pages

Gatsby Cheat Sheet

This document provides commands and definitions for using Gatsby. It lists commands to install Gatsby CLI, create new sites, develop sites, build sites for deployment, and clean caches. It also defines important files used in Gatsby projects like gatsby-config.js, gatsby-node.js, gatsby-browser.js, and gatsby-ssr.js. Quick start commands are provided to create a new site from a starter.

Uploaded by

Gonzalo Sidney
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 2

gatsbyjs.

org gatsbyjs First, install the global executable:

Commands
Gatsby CLI
npm install -g gatsby-cli

Run gatsby --help for a list of commands and options.

Top Docs gatsby new my-site-name

Please turn for more commands ⭝


Create a new local Gatsby site using the default starter (see “Quick
Start Commands” in this cheat sheet on how to use other starters).
Gatsby Docs gatsby.dev/docs
Latest version ↗

Gatsby on GitHub github.com/gatsbyjs/gatsby gatsby develop


Start the Gatsby development server.
Gatsby Tutorial gatsby.dev/tutorial
-H, --host Set host. Defaults to localhost
Quick Start gatsby.dev/quick-start
v1.0 for Gatsby 2.x

(for intermediate and -p, --port Set port. Defaults to 8000


advanced developers)
-o, --open Open the site in your (default) browser for you
Gatsby Starters gatsby.dev/starters
-S, --https Use HTTPS
Quick Reference Guide gatsby.dev/recipes
Cheat Sheet

Adding Images gatsby.dev/image gatsby build


Compile your application and make it ready for deployment.
Gatsby Node APIs gatsby.dev/api
--prefix-paths Build site with link paths prefixed
Querying with GraphQL gatsby.dev/graphql (set pathPrefix in your config)

Deploying and Hosting gatsby.dev/deploy --no-uglify Build site without uglifying JS bundles
(for debugging)
Using Gatsby Link gatsby.dev/link
--open-tracing-config- Tracer configuration file (OpenTracing
Static Query gatsby.dev/static-query file compatible). See gatsby.dev/tracing

How to Contribute gatsby.dev/contribute


gatsby serve Create a new Gatsby site using the “Blog” starter:

Commands
Quick Start
Serve the production build for testing. gatsby new my-blog-starter https://github.com/

-H, --host Set host. Defaults to localhost gatsbyjs/gatsby-starter-blog

-p, --port Set port. Defaults to 9000 Navigate into your new site’s directory and start it up:

-o, --open Open the site in your (default) browser for you cd my-blog-starter/
gatsby develop
--prefix-paths Serve site with link paths prefixed (if built with
pathPrefix in your gatsby-config.js)
Your site is now running at http://localhost:8000!
You’ll also see a second link: http://localhost:8000/___
gatsby info graphql. This is a tool you can use to experiment with
Get helpful environment information which will be required querying your data. Learn more about it at gatsby.dev/tutorial
when reporting a bug at github.com/gatsbyjs/gatsby/issues.

-C, --clipboard Automagically copy environment information For more Gatsby starters, visit gatsby.dev/starters.
to clipboard

gatsby clean
Wipe out Gatsby’s .cache and public directories. Each of these files should live at the root of your Gatsby

Definitions
Helpful File
project folder. See gatsby.dev/projects

gatsby-config.js — configure options for a Gatsby site,


with metadata for project title, description, plugins, etc.
T-Shirts, Hats, Hoodies, and more! gatsby-node.js — implement Gatsby’s Node.js APIs to cus-

Sign up for the Gatsby Newsletter and get 30% off your tomize and extend default settings affecting the build process

Gatsby Store purchase! (gatsby.dev/store) gatsby-browser.js — customize and extend default set-
tings affecting the browser, using Gatsby’s browser APIs

Sign up at gatsby.dev/discount gatsby-ssr.js — use Gatsby’s server-side rendering APIs to


customize default settings affecting server-side rendering

You might also like

pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy