question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Embedding GraphiQL via markdown

See original GitHub issue

Is there a documentation how we can integrate GraphiQL in our existing markdown-based documentation?

We`d like to have something like this:

# { "graphiql": true }
{
  hero {
    name
  }
}

Is there a tutorial or something like that on how they did that?

Issue Analytics

  • State:open
  • Created 3 years ago
  • Comments:6 (4 by maintainers)

github_iconTop GitHub Comments

1reaction
saihajcommented, Jan 18, 2021

@FrankR85 on graphql.org MiniGraphiql component is used with the marked which is probably not as powerful as graphiql but good enough for the docs site

1reaction
PrakharUniyalcommented, Dec 16, 2020

You mean like this?

# { "graphiql": true }
{
  hero {
    name
  }
}

Use ```graphql in the beginning of your code block.

Read more comments on GitHub >

github_iconTop Results From Across the Web

graphql-markdown - npm
The easiest way to document your GraphQL schema. ... This package will generate Markdown that beautifully renders your GraphQL schema in an easily ......
Read more >
Adding Markdown Pages - Gatsby
Gatsby can use markdown files to create pages in your site. ... You can then query the data through the GraphQL API from...
Read more >
Complete guide to GraphQL Playground - LogRocket Blog
There are so many tools that make learning and using GraphQL easier. ... documentation explorer, search, markdown support, and so much more.
Read more >
GraphiQL for ASP.​NET Core
Now start the web using Visual Studio (press [F5]). The web starts with the default view or API. Add "graphiql" to the URL...
Read more >
GraphQL, Rich Text Editor & Redesigned Dashboard - Strapi
The idea with this plugin was to add a new layer to easily request the API using GraphQL, without breaking the existing endpoints....
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found