@graphql-markdown/cli

Generate Markdown documentation from GraphQL schemas

npmmacoslinuxwindows

Try with needOr install directly

About

NodeJS CLI for generating Markdown documentation from a GraphQL schema.

graphql-markdown

create markdown docs from a graphql schema file$ graphql-markdown schema.graphql

generate documentation and save to custom output folder$ graphql-markdown schema.graphql --out ./docs

document a remote graphql endpoint$ graphql-markdown https://api.example.com/graphql

generate docs with custom markdown template$ graphql-markdown schema.graphql --template custom-template.md

create documentation with table of contents and descriptions$ graphql-markdown schema.graphql --table-of-contents