Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(v2): Add docusaurus2-graphql-doc-generator to community resources #4256

Merged
merged 1 commit into from
Feb 22, 2021
Merged

Conversation

edno
Copy link
Contributor

@edno edno commented Feb 20, 2021

Motivation

As a team developing a GraphQL gateway, we wanted to be able to have an easy way to discover and search through the API without having to explore it using GraphiQL. Since, we were already using Docusaurus as documentation portal, it seems to be a perfect fit for generating API documentation.

We have developed a small plugin that converts a GraphQL schema into hyperlinked markdown pages compatible with Docusaurus docs.

screenshot-localhost_8080-2021 02 20-09_44_02

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

Tests can be found in https://github.com/edno/docusaurus2-graphql-doc-generator/tree/main/tests

Related PRs

None

@netlify
Copy link

netlify bot commented Feb 20, 2021

@github-actions
Copy link

Size Change: 0 B

Total Size: 543 kB

ℹ️ View Unchanged
Filename Size Change
website/build/assets/css/styles.********.css 86.6 kB 0 B
website/build/assets/js/main.********.js 370 kB 0 B
website/build/blog/2017/12/14/introducing-docusaurus/index.html 60.5 kB 0 B
website/build/docs/introduction/index.html 235 B 0 B
website/build/index.html 25.6 kB 0 B

compressed-size-action

@netlify
Copy link

netlify bot commented Feb 20, 2021

Deploy preview for docusaurus-2 ready!

Built without sensitive environment variables with commit 7339be1

https://deploy-preview-4256--docusaurus-2.netlify.app

@slorber
Copy link
Collaborator

slorber commented Feb 22, 2021

Thanks :)

@slorber slorber changed the title Add docusaurus2-graphql-doc-generator to community resources docs(v2): Add docusaurus2-graphql-doc-generator to community resources Feb 22, 2021
@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Feb 22, 2021
@slorber slorber merged commit ffb9ad0 into facebook:master Feb 22, 2021
@edno edno deleted the patch-1 branch February 22, 2021 14:56
@lex111 lex111 added this to the v2.0.0-alpha.71 milestone Mar 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants