0.2.0-alpha

CHANGELOG [03/16/22]

Current version 0.2.0-alpha. Please refer to README.md for installation and usage.

• feat: frontmatter, a feature that is currently in test-drive mode
• bugfix: custom comment tags doesn't render output accordingly

0.1.2-alpha

CHANGELOG [03/09/22]

Current version 0.1.2-alpha. Please refer to README.md for installation and usage.

• bugfix: removed formatting for mutation, causes the app to crash when mutation syntax is invalid.

---

CHANGELOG [03/06/22]

0.1.1-alpha.

• bugfix: GraphQL variable object children doesn't get included.

---

CHANGELOG [03/04/22]

v0.1.0-alpha. Please refer to README.md for installation and usage.

• initial version
• feat: automatically generate requests' markdown docs
• feat: export markdown docs for a single or multiple request
• feat: customize example code block placements

0.1.1-alpha

CHANGELOG [03/06/22]

Current version 0.1.1-alpha. Please refer to README.md for installation and usage.

• bugfix: GraphQL variable object children doesn't get included.

---

CHANGELOG [03/04/22]

v0.1.0-alpha. Please refer to README.md for installation and usage.

• initial version
• feat: automatically generate requests' markdown docs
• feat: export markdown docs for a single or multiple request
• feat: customize example code block placements

v0.1.0

CHANGELOG

• initial version 0.1.0-alpha
• automatically generate requests' markdown docs
• export markdown docs for a single or multiple request
• customize example code block placements

GraphQL Markdown Doc Generator

Installation

• Download the latest release here.
• Go to Paw > Preferences or simply use the keyboard shortcut: cmd + ,
• Click on the Extensions tab > Open Directory, extract the content of the zip file in that directory.
• You should see GraphQLDocs Generator listed.
• Create a new Request, and on the Generators dropdown, select GraphQLDocs

Usage

• See how to Export single Request
• See how to Export multiple Request

By default, GraphQLDocs will generate a markdown document based on the Request information
available. Basic Response information will only be available if there's at least one Http Exchange. It will
always render the latest exchange.

You may also customize the documentation output by using the comment tags on the
description textarea like so:

### Request 101

This comment tag below will render the request's headers.

<!-- request:headers -->

This comment tag below will render the request's body

<!-- request:body -->

By appending `:collapsed` to the tag will wrap the code block with `<details> ... </details>` markup tag
which makes it collapsible when rendered in Github Markdown.

Here's a list of available comment tags:

Request Headers
<!-- request:headers -->
or
<!-- request:headers:collapsed -->

Request URLParams
<!-- request:urlparams -->
or
<!-- request:urlparams:collapsed -->

Request Body
<!-- request:body -->
or
<!-- request:body:collapsed -->

Response Headers
<!-- response:headers -->
or
<!-- response:headers:collapsed -->

Response Body
<!-- response:body -->
or
<!-- response:body:collapsed -->

Export Markdown doc for single Request

Export Markdown for multiple Request