https://github.com/graphql-markdown/graphql-markdown

Flexible GraphQL Documentation Generator (Markdown)
https://github.com/graphql-markdown/graphql-markdown

astrojs documentation documentation-generator docusaurus fumadocs generator gql graphql graphql-config graphql-markdown graphql-schema markdown nextjs starlight

Last synced: about 22 hours ago
JSON representation

Flexible GraphQL Documentation Generator (Markdown)

• Host: GitHub
• URL: https://github.com/graphql-markdown/graphql-markdown
• Owner: graphql-markdown
• License: mit
• Created: 2020-06-12T08:17:12.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2025-04-09T22:52:52.000Z (5 days ago)
• Last Synced: 2025-04-09T23:34:16.783Z (5 days ago)
• Topics: astrojs, documentation, documentation-generator, docusaurus, fumadocs, generator, gql, graphql, graphql-config, graphql-markdown, graphql-schema, markdown, nextjs, starlight
• Language: TypeScript
• Homepage: https://graphql-markdown.dev
• Size: 28.6 MB
• Stars: 146
• Watchers: 1
• Forks: 29
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

• project-awesome - graphql-markdown/graphql-markdown - Flexible GraphQL Documentation Generator (Markdown) (TypeScript)

README

        
[![GraphQL-Markdown](https://user-images.githubusercontent.com/324670/188957463-dae99daa-763d-466e-91f4-0629f455df74.svg)](https://graphql-markdown.dev)

Flexible documentation for GraphQL schemas


[![Latest Version](https://img.shields.io/npm/v/@graphql-markdown/docusaurus?style=flat)](https://www.npmjs.com/package/@graphql-markdown/docusaurus)

[![GitHub License](https://img.shields.io/github/license/graphql-markdown/graphql-markdown?style=flat)](https://raw.githubusercontent.com/graphql-markdown/graphql-markdown/main/LICENSE)

[![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen)](https://plant.treeware.earth/graphql-markdown/graphql-markdown)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

# GraphQL-Markdown

Generate **Markdown documentation** from **GraphQL schemas** for static site generators.

## Installation

Choose your preferred package based on your static site generator:

```shell

# For Docusaurus

npm install @graphql-markdown/docusaurus graphql

# For other static site generators

npm install @graphql-markdown/cli graphql

```

## Usage

### Docusaurus Plugin

Add to your `docusaurus.config.js`:

```js

module.exports = {

  plugins: ["@graphql-markdown/docusaurus"],

};

```

Run the generation command:

```shell

npx docusaurus graphql-to-doc

```

### CLI Usage

```shell

npx gqlmd graphql-to-doc --schema ./schema.graphql --output ./docs

```

## Configuration

See [documentation configuration](https://graphql-markdown.dev/docs/configuration) page.

## Troubleshooting

See [documentation troubleshooting](https://graphql-markdown.dev/docs/troubleshooting) page.

## License

GraphQL-Markdown packages are 100% free and open-source, under the [MIT license](https://github.com/graphql-markdown/graphql-markdown/blob/main/LICENSE).

This package is [Treeware](https://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/graphql-markdown/graphql-markdown) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

## Contributions

[Contributions](https://github.com/graphql-markdown/graphql-markdown/blob/main/CONTRIBUTING.md), issues and feature requests are very welcome. If you are using this package and fixed a bug for yourself, please consider submitting a PR!