v7.0.0

Breaking Change

• The minimum supported Node.js version has been bumped to 14.0.0.
• All dependencies have been bumped where possible; these may come with their own new system requirements (e.g. minimum Node.js version).

Internal

• Adopt standard Prettier config rather than less popular "Standard" config.

v6.1.0

• Add support for GraphQL v16. (#87, thanks @nextdude!)

v6.0.0

Breaking Change

• The introspection query is now obtained via .getIntrospectionQuery() rather than .introspectionQuery, which means versions of graphql prior to its introduction in v0.12 are no longer supported.
• The graphql package was moved from dependencies to peerDependencies, so it will no longer be automatically installed with this package. This should mean that there won't potentially be multiple versions of graphql installed in node_modules and this package should just inherit whichever you already use (even though it should have already anyway due to it being resolved with resolve-from).

New Feature

• Support for graphql v15, which removed the deprecated .introspectionQuery API in favor of .getIntrospectionQuery(). (#65, @aisapatino)
• Support for rendering UNION types. (#53, @nextdude)

v5.2.0

New Feature

• Added --no-toc CLI option and skipTableOfContents Node API for skipping the Table of Contents rendering. #48, thanks @p-janik!

v5.1.0

New Feature

• The new --header CLI param allows you to add arbitrary HTTP headers to the request when fetching a remote GraphQL schema (#40). Thanks to @johannespfeiffer and @ruben-podadera for the original idea.

v5.0.1

Fixed

• Remove accidental trailing space after Query and Mutation section heading names.
• Improved GraphQLSchema instance detection.

v5.0.0

Changed

• Bumped all dependencies, including GraphQL. Note that this library still tries to use the schema's local version of GraphQL if you point it at a module.
• Dropped support for Node versions below 8.10.0.
• Improved test suite.

Added

• Support for Input Types. Thanks @thomasmichaelwallace! (#34)
• Modules can now export a Promise that resolves to a schema.

v4.1.0

Added

• Mutation support! Thanks @adamisntdead! (#27)

v4.0.0

Changed

• Node 8.10 is now the minimum supported version of Node.
• All dependencies have been upgraded, including GraphQL.

v3.2.0

Added

• New renderSchema option, headingLevel(CLI: --heading-level), which specifies the initial level of Markdown headings in the generated output.
• New renderSchema option, skipTitle (CLI: --no-title), to skip printing a document title.
• New function, updateSchema, which updates an existing Markdown document in-place. It looks for <!-- START graphql-markdown --> and <!-- END graphql-markdown --> comment markers and injects the rendered schema between them, so you can print the schema to just one section of the document.
• New CLI option, --update-file, which will trigger updateSchema instead of renderSchema.

Changed

• Bumped dependencies.