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).

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

LekoArts

GraphQL Playground

GraphQL Playground is released under the 0BSD license. GitHub Sponsors Website Follow @lekoarts_de

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 check out other Free & Open Source Gatsby Themes and my Personal Website.

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

Deploy to Gatsby Cloud

1. Create a Gatsby site.

Use git to clone the site and navigate into it:

git clone https://github.com/LekoArts/gatsby-starter-graphql-playground project-name
cd project-name

2. Install dependencies.

If you use npm 7 or above use the --legacy-peer-deps flag. If you use npm 6 you can use npm install.

npm install --legacy-peer-deps

3. Open the code and start customizing!

Start the site by running npm run develop.

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 check out 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

Changing the Navigation

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

Adding a new doc page

First, create a new entry in your navigation.mdx file. If this file doesn't exist yet, see the step above.

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/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 "Welcome" text

Create a file at src/@lekoarts/gatsby-theme-graphql-playground/data/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! You can use Real Favicon Generator to generate the image files inside static.

🤔 Questions or problems?

If you have general questions or need help with Gatsby, please go to one of the support platforms mentioned in Gatsby's documentation. If you have a specific question about this project, you can head to the GitHub Discussions of the repository.

🎓 Learning Gatsby

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

Themes

To learn more about Gatsby themes specifically, I 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 or GitHub Sponsor!

About

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).

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published