Skip to main content

Recipes: Pages and Layouts

Add pages to your Gatsby site, and use layouts to manage common page elements.

Project structure

Inside a Gatsby project, you may see some or all of the following folders and files:

Some notable files and their definitions:

  • gatsby-config.js — configure options for a Gatsby site, with metadata for project title, description, plugins, etc.
  • gatsby-node.js — implement Gatsby’s Node.js APIs to customize and extend default settings affecting the build process
  • gatsby-browser.js — customize and extend default settings affecting the browser, using Gatsby’s browser APIs
  • gatsby-ssr.js — use Gatsby’s server-side rendering APIs to customize default settings affecting server-side rendering

Additional resources

Creating pages automatically

Gatsby core automatically turns React components in src/pages into pages with URLs. For example, components at src/pages/index.js and src/pages/about.js would automatically create pages from those filenames for the site’s index page (/) and /about.

Prerequisites

Directions

  1. Create a directory for src/pages if your site doesn’t already have one.
  2. Add a component file to the pages directory:
  1. Run gatsby develop to start the development server.
  2. Visit your new page in the browser: http://localhost:8000/about

Additional resources

Linking between pages

Routing for links internal to your Gatsby site relies on the <Link /> component.

Prerequisites

  • A Gatsby site with two page components: index.js and contact.js
  • The Gatsby CLI to run gatsby develop

Directions

  1. Open the index page component (src/pages/index.js) and import the <Link /> component from Gatsby. Add a <Link /> component to the JSX code and give it a to property with the pathname value of "/contact/" to output an HTML link with Gatsby powers:
  1. Run gatsby develop and navigate to the index page. You should have a link that takes you to the contact page when clicked!

Note: Gatsby’s <Link /> component is a wrapper around @reach/router’s Link component. It outputs an HTML anchor when rendered in a browser, with built-in JavaScript functionality for performance. For more information, consult the API reference for <Link />.

Additional resources

Creating a layout component

It’s common to wrap pages with a React layout component, which makes it possible to share markup, styles, and functionality across multiple pages.

Prerequisites

Directions

  1. Create a layout component in src/components, where child components will be passed in as props:
  1. Import and use the layout component in a page:

Additional resources

Creating pages programmatically with createPage

You can create pages programmatically in the gatsby-node.js file with helper methods Gatsby provides.

Prerequisites

Directions

  1. In gatsby-node.js, add an export for createPages
  1. Destructure the createPage action from the available actions so it can be called by itself, and add or get data
  1. Loop through the data in gatsby-node.js and provide the path, template, and context (data that will be passed in the props’ pageContext) to createPage for each invocation
  1. Create a React component to serve as the template for your page that was used in createPage
  1. Run gatsby develop and navigate to the path of one of the pages you created (like at http://localhost:8000/Fido) to see the data you passed it displayed on the page

Additional resources


Edit this page on GitHubLast updated: