https://github.com/inevolin/graphql-docs

Documentation generator for GraphQL based on Mkdocs and Introspection Queries
https://github.com/inevolin/graphql-docs

docs documentation documentation-generator documentation-tool graphql graphql-api graphql-docs mkdocs mkdocs-plugin

Last synced: 2 months ago
JSON representation

Documentation generator for GraphQL based on Mkdocs and Introspection Queries

• Host: GitHub
• URL: https://github.com/inevolin/graphql-docs
• Owner: inevolin
• Created: 2021-07-12T20:14:54.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-07-12T21:42:19.000Z (almost 4 years ago)
• Last Synced: 2025-01-11T09:47:28.797Z (4 months ago)
• Topics: docs, documentation, documentation-generator, documentation-tool, graphql, graphql-api, graphql-docs, mkdocs, mkdocs-plugin
• Language: JavaScript
• Homepage:
• Size: 95.7 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# GraphQL Generated Docs

## Requirements

 - NodeJS v12+

 - Python 3.7+ with pip

 - Install mkdocs: `pip install mkdocs`

 - Install mkdocs Material theme: `pip install mkdocs-material` [docs](https://squidfunk.github.io/mkdocs-material/customization/)

 - Test the mkdocs command: `mkdocs --version`

## Usage

  1. clone the repo

  2. run `npm install`

  3. run `npm start` or `node index.js` this will generate the `./docs/` files

  4. run `mkdocs serve` and open `localhost:8000`

  5. run `mkdocs build` to generate static html in `./site/`

  

 * Mkdocs generates important INFO logs (eg: missing important md files)

 * **Important:** during development & testing use the `dump.json` method instead of getting schema from API.