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

Markdown version #5

Open
Koleok opened this issue Feb 3, 2017 · 2 comments · May be fixed by #6
Open

Markdown version #5

Koleok opened this issue Feb 3, 2017 · 2 comments · May be fixed by #6

Comments

@Koleok
Copy link

Koleok commented Feb 3, 2017

Have you considered adding a markdown version? I'd be glad to do it if necessary I just think it would add value to this project as far as being at least Cmd/Ctrl+F searchable but also providing permalinks to sections and lines.

@sogko
Copy link
Owner

sogko commented Feb 3, 2017

Hi @Koleok

That's actually a great idea! If you are considering creating a PR, I'd be more than happy to accept it and include it here.

And I just found out that Github's markdown accepts 'graphql' format for its code-fencing and a quick test below seems to be working great.

Do let me know if you want to pursue this, that'd be great 👍

interface Test {
  id: String
}
type Name {
 id: String
}

type User implements Test {
 id: String
 friend: Boolean
}
input Input {
 val: Int
}
scalar Url

schema {
 query: Query
 mutation: Mutation

}

@Koleok Koleok linked a pull request Feb 7, 2017 that will close this issue
@Koleok
Copy link
Author

Koleok commented Feb 7, 2017

Take a look @sogko! I tweaked a few things specifically in the table descriptions and took the opportunity to link to the official schema docs where applicable. You had some nice color coding between the keyword tables and syntax highlighting in your image which I am sure we could find a way to retain (like wrapping span tags with inline styles around the keywords I think?), I was not sure how off the top of my head since I am no .md expert.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants