Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lekoarts/gatsby-starter-graphql-playground
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).
https://github.com/lekoarts/gatsby-starter-graphql-playground
gatsby gatsby-starter gatsbyjs graphiql graphql mdx-js playground
Last synced: about 1 month ago
JSON representation
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).
- Host: GitHub
- URL: https://github.com/lekoarts/gatsby-starter-graphql-playground
- Owner: LekoArts
- License: 0bsd
- Created: 2019-11-04T17:32:43.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-10T07:31:30.000Z (4 months ago)
- Last Synced: 2024-10-14T04:01:05.828Z (about 1 month ago)
- Topics: gatsby, gatsby-starter, gatsbyjs, graphiql, graphql, mdx-js, playground
- Language: TypeScript
- Homepage: https://gatsby-starter-graphql-playground.netlify.app/
- Size: 3.7 MB
- Stars: 17
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
GraphQL Playground
GraphQL Playground to showcase the power of GraphQL. Write your queries and documentation with [MDX](https://mdxjs.com/) 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`](https://github.com/LekoArts/gatsby-themes/tree/main/themes/gatsby-theme-graphql-playground).
[**Demo Website**](https://gatsby-starter-graphql-playground.netlify.app)
Also be sure to check out other [Free & Open Source Gatsby Themes](https://themes.lekoarts.de) and my [Personal Website](https://www.lekoarts.de?utm_source=graphql-playground&utm_medium=Starter).
## ✨ 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
## ⏱️ Quick Start
Deploy this starter with one click on [Netlify](https://app.netlify.com/signup):
[
](https://app.netlify.com/start/deploy?repository=https://github.com/LekoArts/gatsby-starter-graphql-playground)
## 🚀 Getting Started
### 1. **Create a Gatsby site.**
Use the Gatsby CLI to clone the site and install dependencies:
```sh
npx gatsby new gatsby-starter-graphql-playground https://github.com/LekoArts/gatsby-starter-graphql-playground
```
### 2. **Navigate to your new project.**
```sh
cd gatsby-starter-graphql-playground
```
### 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](https://www.gatsbyjs.com/docs/how-to/plugins-and-themes/using-a-gatsby-theme/) or [longer](https://www.gatsbyjs.com/tutorial/using-a-theme/) 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](https://www.gatsbyjs.com/docs/how-to/plugins-and-themes/shadowing/) 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`](https://github.com/LekoArts/gatsby-themes/tree/main/themes/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:
```markdown
- 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.
````markdown
---
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](https://realfavicongenerator.net/) 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](https://www.gatsbyjs.com/contributing/community/#where-to-get-support) mentioned in Gatsby's documentation. If you have a specific question about this project, you can head to the [GitHub Discussions](https://github.com/LekoArts/gatsby-themes/discussions) of the repository.
## 🎓 Learning Gatsby
Looking for more guidance? Full documentation for Gatsby lives [on Gatsby's website](https://www.gatsbyjs.com/).
### Themes
To learn more about Gatsby themes specifically, I recommend checking out the [theme docs](https://www.gatsbyjs.com/docs/themes/).
### General
- **For most developers, I recommend starting with the [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.com/docs/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.
- **To dive straight into code samples, head [to Gatsby's documentation](https://www.gatsbyjs.com/docs/).** In particular, check out the _How-to Guides_ and _Reference_ items in the primary navigation.
## 🌟 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](https://twitter.com/lekoarts_de) and share the project with me.
Please star this project, share it on Social Media or consider supporting me on [GitHub Sponsors](https://github.com/sponsors/LekoArts)!