Skip to content
GraphQL Playground to showcase the power of GraphQL. Write your queries and documentation with MDX and display queries in an interactive GraphiQL window. It can source from your localhost or a remote URL (e.g. Codesandbox).
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
docs
static Update gatsby-starter-graphql-playground from LekoArts/gatsby-themes Nov 4, 2019
.gitignore
CHANGELOG.md
LICENSE
README.md
gatsby-config.js Update gatsby-starter-graphql-playground from LekoArts/gatsby-themes Nov 4, 2019
package.json
yarn.lock

README.md

LekoArts

GraphQL Playground

GraphQL Playground is released under the MIT license. PRs welcome! Follow @lekoarts_de Netlify Status

GraphQL Playground to showcase the power of GraphQL. Write your queries and documentation with MDX and display queries in an interactive GraphiQL window. It can source from your localhost or a remote URL (e.g. Codesandbox). Using the Gatsby Theme @lekoarts/gatsby-theme-graphql-playground.

Demo Website

Also be sure to checkout other Free & Open Source Gatsby Themes

Features

  • MDX for the navigation and content
  • Automatically converts GraphQL code blocks with the meta field preview to live previews in a GraphiQL iframe
  • Theme UI-based theming
  • Light Mode / Dark Mode

🚀 Getting Started

  1. Create a Gatsby site.

Use the Gatsby CLI to create a new site, specifying this project

gatsby new project-name https://github.com/LekoArts/gatsby-starter-graphql-playground
  1. Start developing.

Navigate into your new site's directory and start it up.

cd project-name
gatsby develop
  1. Open the code and start customizing!

Your site is now running at http://localhost:8000!

If you want to learn more about how you can use a Gatsby starter that is configured with a Gatsby theme, you can checkout this shorter or longer tutorial. The tutorials don't exactly apply to this starter however the concepts are the same.

📝 Using and modifying this starter

Important Note: Please read the guide Shadowing in Gatsby Themes to understand how to customize the underlying theme!

This starter creates a new Gatsby site that installs and configures the theme @lekoarts/gatsby-theme-graphql-playground.

Have a look at the theme's README and files to see what options are available and how you can shadow the various components including Theme UI. Generally speaking you will want to place your files into src/@lekoarts/gatsby-theme-graphql-playground/ to shadow/override files. The Theme UI config can be configured by shadowing its files in src/gatsby-plugin-theme-ui/.

Adding content

Adding a new doc page

First, create a new entry in your navigation.mdx file. If this file doesn't exist yet, create it inside your docsPath (default: docs) folder.

You need to create a "classic" markdown list, like:

- Welcome
- Basics
  - [GraphQL Introduction](/graphql-introduction)

You'll now see a navigation that has two sections (Welcome and Basics) of which Basics has a sub-menu.

Now, create a new file at docs/items/graphql-introduction.mdx. The filename has to be the same as the link you used in the navigation. Add a title to the frontmatter of the MDX file and place the GraphQL query you wish to display in the GraphiQL iFrame as the first item.

---
title: GraphQL Introduction
---

```graphql preview
{
  ...your
  query
  goes
  here
}
```

Normal text can go here.

## Normal markdown too

You need to write your query with graphql preview so that the theme can pick it up. You also must place it directly after the frontmatter.

Changing the "Homepage" text

Create a file at src/@lekoarts/gatsby-theme-graphql-playground/text/index.mdx to edit the text.

Change your static folder

The static folder contains the icons, social media images and robots.txt. Don't forget to change these files, too!

🤔 Questions or problems?

Please open up an issue on the main repository: LekoArts/gatsby-themes. Thanks!

🎓 Learning Gatsby

Looking for more guidance? Full documentation for Gatsby lives on Gatsby's website.

Themes

  • To learn more about Gatsby themes specifically, we recommend checking out the theme docs.

General

🌟 Supporting me

Thanks for using this project! I'm always interested in seeing what people do with my projects, so don't hesitate to tag me on Twitter and share the project with me.

Please star this project, share it on Social Media or consider supporting me on Patreon!

If you want to hire me for contract/freelance work, you can do so! Get in touch with me!

You can’t perform that action at this time.