Skip to main content

Creating slugs for pages

The logic for creating slugs from file names can get tricky, the gatsby-source-filesystem plugin ships with a function for creating them.

Install

npm install --save gatsby-source-filesystem

Create slugs in gatsby-node.js

Add your new slugs directly onto the MarkdownRemark nodes. Any data you add to nodes is available to query later with GraphQL.

To do so, you’ll use a function passed to our API implementation called createNodeField. This function allows you to create additional fields on nodes created by other plugins.

gatsby-node.js
const { createFilePath } = require(`gatsby-source-filesystem`)

exports.onCreateNode = ({ node, getNode, actions }) => {
  const { createNodeField } = actions
  if (node.internal.type === `MarkdownRemark`) {
    const slug = createFilePath({ node, getNode, basePath: `pages` })
    createNodeField({
      node,
      name: `slug`,
      value: slug,
    })
  }
}

Query created slugs

Open refresh GraphiQL, then run this GraphQL query to see all your slugs:

{
  allMarkdownRemark {
    edges {
      node {
        fields {
          slug
        }
      }
    }
  }
}

Was this helpful? edit this page on GitHub