Skip to main content

Submit to Starter Library

Have you created a Gatsby starter you’d like to add to the Starter Library? Follow these instructions.

Steps

To get your site added to the starter library, follow the two steps below.

  1. If this is your first contribution to the Gatsby open source repo, follow the Contribution guidelines.

  2. Edit the starters.yml file by adding your starter information to the bottom of the list in the following format:

docs/starters.yml
- url: Link to a demo of your starter
  repo: Link to GitHub repo
  description: Your starter description

  # These correspond to the category filters in the library
  # Make an effort to use the existing tags, and add more if needed!
  tags:
    - Redux

  # Add your site features
  # These will be included on your starter's detail page.
  features:
    - Blog post listing with previews (image + summary) for each blog post

Use the following template to ensure required fields are filled:

docs/starters.yml
- url: (required)
  repo: (required - https://github.com/{username}/{titleofthesite})
  description: (optional)
  tags:
    - (required)
  features:
    - (optional, but encouraged)

Check out the starters.yml file for examples.

Need to change details?

If you want to edit anything in your site submission later, simply edit the .yml file by submitting another PR. GitHub data (like stars) will be automatically pulled and updated, but your starter description, tags, and feature list are up to you!


Was this helpful? edit this page on GitHub