1.24.1 - 19 Apr 2024

What's Changed

🐛 fix mdx special chars escaped in code section (#1382)
🐛 add missing support for non printable type in examples (#1419)

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.24.0...1.24.1

1.24.0 - 19 Feb 2024

What's Changed

🤖 A new feature printTypeOptions.exampleSection adds supports for examples using schema directives. The feature allows inheritance of examples, so once a scalar is set with an example all types using this scalar will share the example. And, of course, you can override those examples. You can also use a custom directive and custom parser. More details in the documentation.

Object	Operation

The screenshots come from the Group by demo with the feature enabled.

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.23.0...1.24.0

1.23.0 - 10 Feb 2024

What's changed

❇️ Executable types (operations and related directives) and system types (entity types) have now separate sections. The behaviour can be disabled by setting the option printTypeOptions.useApiGroup to false or using the cli flag --noApiGroup (see documentation).

The online examples have been updated with one using the new sections and one with the option disabled. Note that the examples have some custom CSS that is not part of the default package.

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.22.0...1.23.0

1.22.0 - 27 Dec 2023

🧑‍🔧 A new setting docOptions.frontMatter makes it easier to generate pages with Docusaurus settings. Using this setting you can pass any front matter setting to the generator.

Example for the Docusaurus draft setting:

plugins: [
    [
      "@graphql-markdown/docusaurus",
       {
        schema: "./schema/swapi.graphql",
        docOptions: {
          frontMatter: {
            draft: true, // set draft for generated pages
          },
        },
      },
    ],
  ],

This option deprecates the options docOptions.pagination and docOptions.toc (more details in the documentation).

What's Changed

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.21.3...1.22.0

1.21.3 - 24 Nov 2023

🐛 Fix the incorrect build for 1.21.2 that was missing the changes for #1101.

What's Changed

@graphql-markdown/docusaurus@1.21.3

📦 bump dependency @graphql-markdown/core to 1.7.3
📦 bump dependency @graphql-markdown/printer-legacy to 1.5.3

@graphql-markdown/core@1.7.3

📦 bump peer dependency @graphql-markdown/printer-legacy to 1.5.3

@graphql-markdown/printer-legacy@1.5.3

✨ rebuild package

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.21.2...1.21.3

1.21.2 - 22 Nov 2023

🪄 Improve compatibility with Docusaurus 3 by using the new admonition format for the deprecated admonition (see #1096).

Docusaurus 2	Docusaurus 3
`:::caution DEPRECATED`	`:::warning[DEPRECATED]`

What's Changed

@graphql-markdown/docusaurus@1.21.2

📦 bump dependency @graphql-markdown/core to 1.7.2 #1103
📦 bump dependency @graphql-markdown/printer-legacy to 1.5.2 #1103

@graphql-markdown/core@1.7.2

📦 bump peer dependency @graphql-markdown/printer-legacy to 1.5.2 #1103

@graphql-markdown/printer-legacy@1.5.2

✨ (feat) replace caution admonition by warning for docusaurus v3 by @edno in #1101

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.21.1...1.21.2

1.21.1 - 05 Nov 2023

🚀 Fix compatibility with Docusaurus 3, since it comes with MDX v3 that is stricter than the version used by Docusaurus 2. 🚀

The compatibility with Docusaurus 2 is maintained, and there is no plan to drop it.

What's Changed

@graphql-markdown/docusaurus@1.21.1

📦 bump dependency @graphql-markdown/core to 1.7.1 #1075
📦 bump dependency @graphql-markdown/printer-legacy to 1.5.1 #1075

@graphql-markdown/core@1.7.1

📦 bump dependency @graphql-markdown/graphql to 1.0.1 #1075
📦 bump dependency @graphql-markdown/utils to 1.6.1 #1075
📦 bump peer dependency @graphql-markdown/diff to 1.1.1 #1075
📦 bump peer dependency @graphql-markdown/helpers to 1.0.1 #1075
📦 bump peer dependency @graphql-markdown/printer-legacy to 1.5.1 #1075
📦 bump peer dependency graphql-config to 5.0.3 #1075

@graphql-markdown/helpers@1.0.1

📦 bump dependency @graphql-markdown/graphql to 1.0.1 #1075

@graphql-markdown/graphql@1.0.1

📦 bump dependency @graphql-markdown/utils to 1.6.1 #1075

@graphql-markdown/printer-legacy@1.5.1

🐛 fix docusaurus v3 support by @edno in #1073
📦 bump dependency @graphql-markdown/graphql to 1.0.1 #1075
📦 bump dependency @graphql-markdown/utils to 1.6.1 #1075

@graphql-markdown/diff@1.1.1

📦 bump dependency @graphql-markdown/graphql to 1.0.1 #1075
📦 bump dependency @graphql-markdown/utils to 1.6.1 #1075

@graphql-markdown/utils@1.6.1

📝 udpate typedoc to fix compatibility with docusaurus v3 #1072

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.21.0...1.21.1

1.21.0 - 30 Sep 2023

🚀 BIG release 🚀

This is an exceptionally big release packed with a lot of changes, so read carefully the release notes before upgrading.

The main changes are under the hood as we migrated the codebase from Javascript to Typescript to simplify the coding experience but also to increase the code safety.

⚠️ Breaking changes

Custom directive helpers have been moved to dedicated packages, see docs.

✨ New features

onlyDocDirective filters the schema entities to be rendered in the documentation. This is the counterpart of skipDocDirective, based on a request from @brampurnot in #994. See documentation.
metatags adds HTML metadata to pages using Docusaurus head metadata, based on a request from @akillkumar in #1015. See documentation.
Helper directiveDescriptor now supports the description placeholder, where description is the default directive's description.

🛠️ Other changes

Typing is available in a dedicated package @graphql-markdown/types.
Modules helpers, graphql and logger have been extracted from @graphql-markdown/utils into dedicated packages.
Logger has now a single method called log().
TS API is getting documented, see API in the docs.
More and better tests.
Upgrade dependencies version.

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.20.4...1.21.0

1.21.0-next.0 - 21 Aug 2023

This is a pre-release following the code base migration from JS to TS.

Breaking change

Custom directive helpers have been moved to dedicated packages, see docs.

Patch change

Helper directiveDescriptor now supports description placeholder, where description is the default directive description.

Technical change

Typing is available in a dedicated package @graphql-markdown/types.
Modules helpers, graphql and logger have been extracted from @graphql-markdown/utils into their own package.
Logger has now a single method called Logger().
TS API is getting documented, see API in our docs.
More and better tests.

1.20.4 - 07 Aug 2023

🧑‍💻 Technical release to freeze the last JS changes before the migration of the code to TS.

What's Changed

@graphql-markdown/docusaurus@1.20.4

📦 bump dependency @graphql-markdown/core to 1.6.4

@graphql-markdown/core@1.6.4

🐛 fix typo in generateDocFromSchema (no impact) by @edno in #917

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.20.3...1.20.4

1.20.3 - 19 Jul 2023

🐛 Fix a CSS issue for type badges in related type sections (see option printTypeOptions.relatedTypeSection).

Before fix 😞
After fix 😀

What's Changed

@graphql-markdown/docusaurus@1.20.3

📦 bump dependency @graphql-markdown/core to 1.6.3
📦 bump dependency @graphql-markdown/printer-legacy to 1.4.3

@graphql-markdown/core@1.6.3

📦 bump peerDependency @graphql-markdown/printer-legacy to 1.4.3

@graphql-markdown/printer-legacy@1.4.3

🐛 fix badge css for relation of type sections by @edno in #908

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.20.2...1.20.3

1.20.2 - 07 Jul 2023

✨ New option printTypeOptions.codeSection and CLI flag --noCode for hiding the codeblock section, based on an initial request from @ris314 in #895. See documentation for more information.

What's Changed

@graphql-markdown/docusaurus@1.20.2

✨ add print option to hide code blocks by @edno in #897
📦 bump dependency @graphql-markdown/core to 1.6.2
📦 bump dependency @graphql-markdown/printer-legacy to 1.4.2

@graphql-markdown/core@1.6.2

✨ add print option to hide code blocks by @edno in #897
📦 bump peerDependency @graphql-markdown/printer-legacy to 1.4.2

@graphql-markdown/printer-legacy@1.4.2

✨ add print option to hide code blocks by @edno in #897

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.20.1...1.20.2

1.20.1 - 06 Jul 2023

What's Changed

📦 Update compatibility with prettier v3 when using pretty setting. 🪄

@graphql-markdown/docusaurus@1.20.1

📦 bump dependency @graphql-markdown/core to 1.6.1
📦 bump dependency @graphql-markdown/printer-legacy to 1.4.1

@graphql-markdown/core@1.6.1

📦 chore(deps): update dependency prettier to v3 by @renovate in #892
📦 bump dependency @graphql-markdown/utils to 1.5.1
📦 bump peerDependency @graphql-markdown/diff to 1.0.14
📦 bump peerDependency @graphql-markdown/printer-legacy to 1.4.1

@graphql-markdown/utils@1.5.1

📦 chore(deps): update dependency prettier to v3 by @renovate in #892

@graphql-markdown/printer-legacy@1.4.1

📦 bump dependency @graphql-markdown/utils to 1.5.1

@graphql-markdown/diff@1.0.14

📦 bump dependency @graphql-markdown/utils to 1.5.1

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.20.0...1.20.1

1.20.0 - 01 Jul 2023

✨ GraphQL Config is now supported, see the documentation for more information and limitations 🚀

This is the default set up when creating a new site using the template.

First install the package graphql-config, then you are ready to go.

npm install graphql-config

Example .graphqlrc:

schema: "https://graphql.anilist.co/"
extensions:
  graphql-markdown:
    linkRoot: "/examples/default"
    baseURL: "."
    homepage: "data/anilist.md"
    loaders:
      UrlLoader:
        module: "@graphql-tools/url-loader"
        options: 
          method: "POST"
    printTypeOptions:
      deprecated: "group"
    docOptions:
      pagination: false
      toc: false

What's Changed

@graphql-markdown/docusaurus@1.20.0

@graphql-markdown/core@1.6.0

✨ add support for graphql-config (#828) by @edno in #885
✨ add graphql-config projects support by @edno in #888
✨ support schema options in graphql-config by @edno in #889
📦 bump peerDependency @graphql-markdown/diff to 1.0.13

@graphql-markdown/diff@1.0.13

📦 fix(deps): update dependency @graphql-inspector/core to v4.2.2 by @renovate in #880
📦 fix(deps): update dependency @graphql-inspector/core to v5 by @renovate in #881

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.19.0...1.20.0

1.19.0 - 03 Jun 2023

⚠️ This release introduces minor breaking changes, see section breaking changes.

🏷️ Building upon customDirective released in 1.18.0, we added a new option tag that allows one to display custom badges (tags) in the documentation pages.

The feature is an extension of the customDirective by using the already available directive processing. It works the same way as descriptor, and it also comes with an helper directiveTag... more details in the documentation.

  customDirective: {
    beta: {
      tag: (directive) => ({
        text: directive?.name.toUpperCase(),
        classname: "badge--danger",
      }),
    },

Breaking changes

Since tags have now a dedicated handler, the directives declared in customDirective for descriptor won't display a badge. A helper helper.directiveTag is provided for backward compatibility. Users who want to keep the previous behavior just need to declare tag: helper.directiveTag for each directive declared.

const { helper } = require("@graphql-markdown/utils");

//---//
  auth: {
      descriptor: (directive, type) =>
        helper.directiveDescriptor(
          directive,
          type,
          "This requires the current user to be in `${requires}` role.",
        ),
      tag: helper.directiveTag,
    },

The deprecated "warning badge" has been changed into an admonition for a clearer UI.
Last change is the change of position of the custom directive descriptions that are now after the type description instead of before.

What's Changed

@graphql-markdown/docusaurus@1.19.0

📦 bump dependency @graphql-markdown/core from 1.4.2 to 1.5.0
📦 bump dependency @graphql-markdown/printer-legacy from 1.3.1 to 1.3.2
✨ add custom logger support by @edno in #869

@graphql-markdown/core@1.5.0

📦 bump dependency @graphql-markdown/utils from 1.4.1 to 1.5.0
📦 bump peerDependency @graphql-markdown/printer-legacy from 1.3.2 to 1.4.0
📦 bump peerDependency @graphql-markdown/diff from 1.0.11 to 1.0.12
✨ custom tags for types by @edno in #863
✨ add custom logger support by @edno in #869

@graphql-markdown/printer-legacy@1.4.0

📦 bump dependency @graphql-markdown/utils from 1.4.1 to 1.5.0
✨ custom tags for types by @edno in #863

@graphql-markdown/diff@1.0.12

📦 bump dependency @graphql-markdown/utils from 1.4.0 to 1.4.1

@graphql-markdown/utils@1.5.0

✨ custom tags for types by @edno in #863
✨ add custom logger support by @edno in #869

1.18.2 - 01 Jun 2023

❇️ Add wildcard * support for customDirective, more details in the documentation.

What's Changed

@graphql-markdown/docusaurus@1.18.2

📦 bump dependency @graphql-markdown/core from 1.4.1 to 1.4.2
📦 bump dependency @graphql-markdown/printer-legacy from 1.3.1 to 1.3.2

@graphql-markdown/core@1.4.2

📦 bump dependency @graphql-markdown/utils from 1.4.0 to 1.4.1
📦 bump peerDependency @graphql-markdown/printer-legacy from 1.3.1 to 1.3.2
📦 bump peerDependency @graphql-markdown/diff from 1.0.10 to 1.0.11

@graphql-markdown/printer-legacy@1.3.2

📦 bump dependency @graphql-markdown/utils from 1.4.0 to 1.4.1

@graphql-markdown/diff@1.0.11

📦 fix(deps): update graphql-tools monorepo to v8 (major) by @renovate in #854
📦 bump dependency @graphql-markdown/utils from 1.4.0 to 1.4.1

@graphql-markdown/utils@1.4.1

📦 fix(deps): update graphql-tools monorepo to v8 (major) by @renovate in #854
✨ add wildcard support to custom directive feature by @edno in #860

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.18.1...1.18.2

1.18.1 - 07 May 2023

🐛 Fix missing code indentation for fields in some cases (#850) by @ljiang-ti in #851.

What's Changed

@graphql-markdown/docusaurus@1.18.1

📦 bump dependency @graphql-markdown/core from 1.4.0 to 1.4.1
📦 bump dependency @graphql-markdown/printer-legacy from 1.3.0 to 1.3.1

@graphql-markdown/core@1.4.1

📦 bump peerDependency @graphql-markdown/printer-legacy from 1.3.0 to 1.3.1

@graphql-markdown/printer-legacy@1.3.1

🐛 Fix indentation level in code section by @ljiang-ti in #851

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.18.0...1.18.1

1.18.0 - 05 May 2023

🤩 A new really cool feature by @ljiang-ti, customDirective provides documentation of schema directives at type level. One can now choose to print a custom description for schema directives applying to a type or field. ✨

👉 ~~There is a open discussion for this feature, and the possible improvements.~~

plugins: [
  [
    "@graphql-markdown/docusaurus",
    {
      // ... other options
      customDirective: {
        auth: {
          descriptor: (directive, type) =>
            directiveDescriptor(
              directive,
              type,
              "This requires the current user to be in `${requires}` role.",
            ),
        },
        // ... other custom directive options
      },
    },
  ],
],

If you want to see it live, the group-by example documentation has been updated to showcase the feature.

You can find more examples and information regarding helpers to get you started in the documentation.

What's Changed

@graphql-markdown/docusaurus@1.18.0

✨ Support custom directives by @ljiang-ti in #844
📦 bump dependency @graphql-markdown/core from 1.3.0 to 1.4.0
📦 bump dependency @graphql-markdown/printer-legacy from 1.2.3 to 1.3.0

@graphql-markdown/core@1.4.0

🧑‍💻 tidy up core package by @edno in #837
✨ Support custom directives by @ljiang-ti in #844
📦 bump dependency @graphql-markdown/utils from 1.3.0 to 1.4.0
📦 bump peerDependency @graphql-markdown/printer-legacy from 1.2.3 to 1.3.0
📦 bump peerDependency @graphql-markdown/diff from 1.0.9 to 1.0.10

@graphql-markdown/printer-legacy@1.3.0

✨ Support custom directives by @ljiang-ti in #844
📦 bump dependency @graphql-markdown/utils from 1.3.0 to 1.4.0

@graphql-markdown/utils@1.4.0

✨ Support custom directives by @ljiang-ti in #844

@graphql-markdown/diff@1.0.10

📦 npm(deps): Bump @graphql-inspector/core from 4.0.3 to 4.2.1 by @dependabot in #842
📦 bump dependency @graphql-markdown/utils from 1.3.0 to 1.4.0

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.17.3...1.18.0

Changes

1.17.3 - 20 Apr 2023

Fix the issue when an operation and a type have the same name with the feature groupByDirective, reported in #831 🐛

What's Changed

@graphql-markdown/docusaurus@1.17.3

📦 bump dependency @graphql-markdown/core from 1.2.2 to 1.3.0
📦 bump dependency @graphql-markdown/printer-legacy from 1.2.2 to 1.2.3

@graphql-markdown/core@1.3.0

🐛 Support documentation categories by different root types by @ljiang-ti in #833
♻️ move group functions to package utils by @edno in #835
📦 bump dependency @graphql-markdown/utils from 1.2.1 to 1.3.0
📦 bump peerDependency @graphql-markdown/printer-legacy from 1.2.2 to 1.2.3
📦 bump peerDependency @graphql-markdown/diff from 1.0.8 to 1.0.9

@graphql-markdown/printer-legacy@1.2.3

🐛 Support documentation categories by different root types by @ljiang-ti in #833
📦 bump dependency @graphql-markdown/utils from 1.2.1 to 1.3.0

@graphql-markdown/utils@1.3.0

♻️ move group functions to package utils by @edno in #835

@graphql-markdown/diff@1.0.9

📦 bump dependency @graphql-markdown/utils from 1.2.1 to 1.3.0

New Contributors

@ljiang-ti made their first contribution in #833

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.17.2...1.17.3

1.17.2 - 17 Apr 2023

Fix issue on schema loader options (#815) by @chmanie 🐛

What's Changed

@graphql-markdown/core@1.17.2

📦 Bump dependency @graphql-markdown/core from 1.2.1 to 1.2.2
📦 Bump peerDependency @graphql-markdown/printer-legacy from 1.2.1 to 1.2.2

@graphql-markdown/core@1.2.2

📦 Bump dependency @graphql-markdown/utils from 1.2.0 to 1.2.1
📦 Bump peerDependency @graphql-markdown/printer-legacy from 1.2.1 to 1.2.2
📦 Bump peerDependency @graphql-markdown/diff from 1.0.7 to 1.0.8

@graphql-markdown/printer-legacy@1.2.2

📦 Bump @graphql-markdown/utils from 1.2.0 to 1.2.1

@graphql-markdown/diff@1.0.8

📦 npm(deps): Bump @graphql-inspector/core from 4.0.2 to 4.0.3 by @dependabot in #826
📦 npm(deps): Bump @graphql-tools/load from 7.8.13 to 7.8.14 by @dependabot in #827
📦 Bump dependency @graphql-markdown/utils from 1.2.0 to 1.2.1

@graphql-markdown/utils@1.2.1

📦 npm(deps): Bump @graphql-tools/load from 7.8.13 to 7.8.14 by @dependabot in #827
🐛 Merge loaderOptions into loader object passed to graphql-tools by @chmanie in #814

New Contributors

@chmanie made their first contribution in #814

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.17.1...1.17.2

1.17.1 - 16 Apr 2023

🐞 Fix some inconsistencies when handling @deprecated directive:

@deprecated is now printed in code snippets for a better visibility
printDeprecated: "skip" skips all deprecated types, including types in code snippets and metadata (fields, enum values)

What's Changed

@graphql-markdown/docusaurus@1.17.1

📦 bump dependency @graphql-markdown/core from 1.2.0 to 1.2.1
📦 bump dependency @graphql-markdown/printer-legacy from 1.2.0 to 1.2.1

@graphql-markdown/core@1.2.1

📦 bump peerDependency @graphql-markdown/printer-legacy from 1.2.0 to 1.2.1

@graphql-markdown/printer-legacy@1.2.1

✨ improve handling of deprecated directive by @edno in #824

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.17.0...1.17.1

1.17.0 - 02 Apr 2023

What's Changed

Lot of changes in this release 🚀

🐛 fix multiline description formatting reported by @patrys in #808
✨ options skipDocDirective and --skip now support multiple values
🔮 new options printTypeOptions.deprecated and --deprecated give more control over deprecated types, based on an initial request from @patrys in #735

The new option printTypeOptions.deprecated comes with several options (see documentation), and the most exciting of those allows @deprecated entities to be grouped together - and, it is customisable (see documentation).

@graphql-markdown/docusaurus@1.17.0

✨ option skipDocDirective supports multiple values by @edno in #810
✨ printTypeOptions by @edno in #806
📦 bump dependency @graphql-markdown/core from 1.1.7 to 1.2.0
📦 bump dependency @graphql-markdown/printer-legacy from 1.1.7 to 1.2.0

@graphql-markdown/core@1.2.0

✨ option skipDocDirective supports multiple values by @edno in #810
✨ printTypeOptions group deprecated by @edno in #806
✨ add printTypeOptions deprecated 'skip' by @edno in #811
📦 bump dependency @graphql-markdown/utils from 1.1.4 to 1.2.0
📦 bump peerDependency @graphql-markdown/printer-legacy from 1.1.7 to 1.2.0
📦 bump peerDependency @graphql-markdown/diff from 1.0.6 to 1.0.7

@graphql-markdown/printer-legacy@1.2.0

🐛 fix multiline description formatting by @edno in #809
✨ option skipDocDirective supports multiple values by @edno in #810
✨ printTypeOptions group deprecated by @edno in #806
📦 bump dependency @graphql-markdown/utils from 1.1.4 to 1.2.0

@graphql-markdown/utils@1.2.0

✨ add isDeprecated in graphql utils
✨ hasDirective now supports array in graphql utils

@graphql-markdown/diff@1.0.7

📦 bump dependency @graphql-markdown/utils from 1.1.4 to 1.2.0

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.16.7...1.17.0

1.16.7 - 28 Mar 2023

What's Changed

🐛 Fix undefined on undeclared root type instead of empty object reported by @LunaticMuch in #802

❕ This release has some significant code refactoring. If you experience regressions with this release, please report them.

@graphql-markdown/docusaurus@1.16.7

📦 bump dependency @graphql-markdown/printer-legacy from 1.1.6 to 1.1.7
📦 bump dependency @graphql-markdown/core from 1.1.6 to 1.1.7

@graphql-markdown/core@1.1.7

📦 bump peerDependencies @graphql-markdown/printer-legacy from 1.1.6 to 1.1.7
📦 bump peerDependencies @graphql-markdown/diff from 1.0.5 to 1.0.6
📦 bump dependency @graphql-markdown/utils from 1.1.3 to 1.1.4

@graphql-markdown/printer-legacy@1.1.7

♻️ refactor printer-legacy by @edno in #763
📦 bump dependency @graphql-markdown/utils from 1.1.3 to 1.1.4

@graphql-markdown/utils@1.1.4

📦 npm(deps): Bump @graphql-tools/load from 7.8.11 to 7.8.12 by @dependabot in #781
📦 npm(deps): Bump @graphql-tools/load from 7.8.12 to 7.8.13 by @dependabot in #794
🐛 fix undefined on undeclared root type instead of empty object by @edno in #803

@graphql-markdown/diff@1.0.6

📦 npm(deps): Bump @graphql-tools/load from 7.8.11 to 7.8.12 by @dependabot in #781
📦 fix(deps): update dependency @graphql-inspector/core to v4 by @renovate in #783
📦 npm(deps): Bump @graphql-tools/load from 7.8.12 to 7.8.13 by @dependabot in #794
📦 bump dependency @graphql-markdown/utils from 1.1.3 to 1.1.4

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.16.6...1.16.7

1.16.6 - 12 Feb 2023

What's Changed

🐛 Fix the support of skipDocDirective on fields, reported by @jroith in #777.

@graphql-markdown/printer-legacy@1.1.6

🐛 fix skipDocDirective on fields by @edno in #779

@graphql-markdown/core@1.1.6

📦 update peerDependency @graphql-markdown/printer-legacy to 1.1.6 by @edno in #780

@graphql-markdown/docusaurus@1.16.6

📦 update dependency @graphql-markdown/printer-legacy to 1.1.6 by @edno in #780
📦 update dependency @graphql-markdown/core to 1.1.6 by @edno in #780

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.16.5...1.16.6

1.16.5 - 04 Feb 2023

What's Changed

🐛 fix undefined css class on returned types and related types badges.

@graphql-markdown/printer-legacy@1.1.5

🐛 fix undefined css class on returned types and related types badges by @edno in #772

@graphql-markdown/core@1.1.5

📦 update peerDependency @graphql-markdown/printer-legacy to 1.1.5 by @edno in #773

@graphql-markdown/docusaurus@1.16.5

📦 update dependency @graphql-markdown/core to 1.1.5 by @edno in #773
📦 update dependency @graphql-markdown/printer-legacy to 1.1.5 by @edno in #773

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.16.4...1.16.5

1.16.4 - 03 Feb 2023

🤩 @carolstran fixed a long due DOM warning where class was used instead of className in React MDX component.

What's Changed

@graphql-markdown/docusaurus@1.16.4

📦 update dependency @graphql-markdown/core to 1.1.4
📦 update dependency @graphql-markdown/printer-legacy to 1.1.4

@graphql-markdown/core@1.1.4

📦 update dependency @graphql-markdown/utils to 1.1.3
📦 update peerDependency @graphql-markdown/diff to 1.0.5
📦 update peerDependency @graphql-markdown/printer-legacy to 1.1.4

@graphql-markdown/printer-legacy@1.1.4

🐛 Refactor class to className in Badge component #765 by @carolstran
📦 update dependency @graphql-markdown/utils to 1.1.3

@graphql-markdown/utils@1.1.3

📦 update dependency @graphql-tools/load to 7.8.11

@graphql-markdown/diff@1.0.5

📦 update dependency @graphql-markdown/utils to 1.1.3
📦 update dependency @graphql-inspector/core to 3.5.0
📦 update dependency @graphql-tools/graphql-file-loader to 7.5.15
📦 update dependency @graphql-tools/load to 7.8.11

New Contributors

@carolstran made their first contribution in #765

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.16.3...1.16.4

1.16.3 - 13 Jan 2023

What's Changed

Fix issue on root scalar types null when using JSON schema loader by @melvey 🐛

@graphql-markdown/utils@1.1.2

🐛 Handle null root types by @melvey in #751

@graphql-markdown/core@1.1.3

📦 Bump dependency @graphql-markdown/utils@1.1.2 by @edno in #754
📦 Bump peerDependency @graphql-markdown/printer-legacy@1.1.3 by @edno in #754
📦 Bump peerDependency @graphql-markdown/diff@1.0.4 by @edno in #754

@graphql-markdown/docusaurus@1.16.3

@graphql-markdown/printer-legacy@1.1.3

📦 Bump dependency @graphql-markdown/utils@1.1.2 by @edno in #754

@graphql-markdown/diff@1.0.4

📦 Bump dependency @graphql-markdown/utils@1.1.2 by @edno in #754
📦 Bump dependency @graphql-tools/graphql-file-loader@7.5.14 by @edno in #754
📦 Bump dependency @graphql-tools/load@7.8.9 by @edno in #754

New Contributors

@melvey made their first contribution in #751

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.16.2...1.16.3

1.16.2 - 07 Jan 2023

What's Changed

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.16.1...1.16.2

1.16.1 - 28 Nov 2022

💥 HOTFIX for release 1.16.0

See 1.16.0 release notes for changes.

@graphql-markdown/docusaurus@1.16.1

bump package @graphql-markdown/core@1.1.1
bump package @graphql-markdown/printer-legacy@1.1.1

@graphql-markdown/core@1.1.1

🐛 fix destructure property bug on @graphql-markdown/core by @edno in #724

@graphql-markdown/printer-legacy@1.1.1

fix dependency semver pattern

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.16...1.16.1

1.16.0 - 28 Nov 2022

❗ DO NOT USE! Broken package @graphql-markdown/core@1.1.0 fixed with release 1.16.1 ❗

What's Changed

✨ Directives are now printed with on location information, eg:

directive @example on
  | FIELD
  | FRAGMENT_SPREAD
  | INLINE_FRAGMENT

🪄 Support excluding types by directive, see doc.

@graphql-markdown/docusaurus@1.16.0

✨ exclude type by directive by @edno in #686

@graphql-markdown/core@1.1.0

✨ exclude type by directive by @edno in #686
📦 npm(deps): Bump @graphql-tools/load from 7.8.0 to 7.8.1 by @dependabot in #698
📦 npm(deps): Bump @graphql-tools/load from 7.8.1 to 7.8.4 by @dependabot in #705
📦 npm(deps): Bump @graphql-tools/load from 7.8.4 to 7.8.6 by @dependabot in #716

@graphql-markdown/utils@1.1.0

✨ add directive locations by @edno in #685
✨ exclude type by directive by @edno in #686

@graphql-markdown/printer-legacy@1.1.0

✨ add directive locations by @edno in #685

@graphql-markdown/diff@1.0.2

bump @graphql-markdown/core to 1.1.0

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/%40graphql-markdown/docusaurus%401.15.1...1.16

1.15 (@graphql-markdown/docusaurus@1.15.1) - 23 Oct 2022

@graphql-markdown/docusaurus@1.15.1

@graphql-markdown/docusaurus is now a micro package part of the graphql-markdown packages ecosystem ✨

‼️ Breaking changes ‼️

@graphql-tools/graphql-file-loader is no more a dependency and must be installed separately in your Docusaurus installation.

npm i @graphql-tools/graphql-file-loader

Explicitly declare the loader in your @graphql-markdown/docusaurus plugin configuration, see the doc.

module.exports = {
 // ...
 plugins: [
   [
     "@graphql-markdown/docusaurus",
     {
       schema: "./schema/swapi.graphql",
       rootPath: "./docs", // docs will be generated under './docs/swapi' (rootPath/baseURL)
       baseURL: "swapi",
       homepage: "./docs/swapi.md",
       loaders: {
         GraphQLFileLoader: "@graphql-tools/graphql-file-loader" // local file schema
       }
     },
   ],
 ],
};

diffMethod is now set to NONE (disabled) by default. If you miss it, see the doc.

@graphql-markdown/core@1.0.1

Update dependency to @graphql-markdown/utils@1.0.1

@graphql-markdown/utils@1.0.1

Fix issue with @graphq-tools/graphql-file-loader required. See release notes for @graphql-markdown/docusaurus@1.15.1

@graphql-markdown/printer-legacy@1.0.1

Update dependency to @graphql-markdown/utils@1.0.1

@graphql-markdown/diff@1.0.1

Update dependency to @graphql-markdown/utils@1.0.1

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.14.0...@graphql-markdown/docusaurus@1.15.1

1.14.0 - 04 Oct 2022

‼️ The package has been renamed to `@graphql-markdown/docusaurus`. ‼️

Migration

Remove the old package: npm uninstall @edno/docusaurus2-graphql-doc-generator
Install the new package: npm install @graphql-markdown/docusaurus

Update docusaurus.config.js

module.exports = {
  // ...
  plugins: [
    [
--    "@edno/docusaurus2-graphql-doc-generator",
++    "@graphql-markdown/docusaurus",
      {
         // ... settings are unchanged
      },
    ],
  ],
  // ...
};

1.13.1 - 04 Sep 2022

What's Changed

improve Docusausus TS support by @edno in #625

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.13.0...1.13.1

1.13.0 - 02 Sep 2022

🪄 A new option for the schema loader allows custom root types in your schema (see documentation), based on a request from @JaKXz.

What's Changed

use prepare script for husky install by @JaKXz in #623
🐛 fix the issue when operation names are used as custom type names by @edno & @JaKXz in #622

New Contributors

@JaKXz made their first contribution in #623

Changes

1.12.1 - 27 Aug 2022

🛠️ Align NodeJS engine min version with Docusaurus.

1.12.0 - 27 Aug 2022

✨ Some shiny new features making the documentation easier to navigate, based on a request from @LunaticMuch.

Type relations give you information about where a type is used: operation, union, interface, type...
Parent prefix makes it easier to read fields in type pages, especially for nested ones
Type attributes badges provide a quick overview of the field attributes such as root type, list, nullability, and groups (if you use the grouping feature)

👀 Look at Demo 1 to see how the documentation renders with those options.

ℹ️ All those options are enabled by default, but they can be toggled off if you don't need them, see the documentation.

💅 Those changes have also been a good opportunity for cleaning the MDX structures in the Markdown generated files.

What's Changed

📦 npm(deps): Bump @graphql-tools/load from 7.7.0 to 7.7.1 by @dependabot in #590
📦 npm(deps): Bump @graphql-tools/graphql-file-loader from 7.4.0 to 7.5.0 by @dependabot in #589
Update dependency graphql to v16.6.0 by @renovate in #605
📦 npm(deps): Bump @graphql-tools/load from 7.7.1 to 7.7.4 by @dependabot in #602
📦 npm(deps): Bump @graphql-tools/graphql-file-loader from 7.5.0 to 7.5.2 by @dependabot in #601
✨ implement type relation map (#585) by @edno in #595
✨ add badges to type information by @edno in #610
✨ add doc group to type badges by @edno in #611

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.11.0...1.12.0

1.11.0 - 17 Jul 2022

✨ New documentation option index for generating index page for schema categories (eg. queries, inputs, mutations...) powered by Docusaurus generated index feature. You can see the option in action in Demo 2.

What's Changed

📦 npm(deps): Bump @graphql-inspector/core from 3.1.2 to 3.2.0 by @dependabot in #572
✨ add support for generated category index by @edno in #575
🧪 improve code coverage by @edno in #577
🧪 update StrykerJS config by @edno in #578
👷 trigger doc generation on release by @edno in #582

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.10.3...1.11.0

1.10.3 - 05 Jul 2022

What's Changed

New Contributors

@renovate made their first contribution in #553

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.10.2...1.10.3

1.10.2 - 04 Jun 2022

This release provides several fixes affecting the rendering of array/list nested types.

What's Changed

♻️ code refactoring by @edno in #541
🐛 fix rendering default array enum by @edno in #544
🐛 fix incorrect link format for arg array types by @edno in #545
🐛 fix printer lib broken logic for nested types by @edno in #546

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.10.1...1.10.2

1.10.1 - 25 May 2022

What's Changed

📦 npm(deps): Bump @graphql-tools/load from 7.5.11 to 7.5.13 by @dependabot in #532
📦 npm(deps): Bump @graphql-tools/graphql-file-loader from 7.3.12 to 7.3.14 by @dependabot in #531
🐛 fix default value 0 not rendered in doc by @edno in #537
🐛 fix missing nullability flag in doc by @edno in #538
🐛 fix missing [] for list entity type by @edno in #539

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.10.0...1.10.1

1.10.0 - 18 May 2022

✨ New options available for disabling Docusaurus navigation buttons and table of content for schema documentation pages. More information in the documentation.

What's Changed

📦 npm(deps): Bump @graphql-tools/graphql-file-loader from 7.3.9 to 7.3.10 by @dependabot in #507
📦 npm(deps): Bump @graphql-tools/load from 7.5.8 to 7.5.9 by @dependabot in #508
📦 npm(deps): Bump @graphql-tools/load from 7.5.9 to 7.5.10 by @dependabot in #509
📦 npm(deps): Bump @graphql-tools/graphql-file-loader from 7.3.10 to 7.3.11 by @dependabot in #511
📦 npm(deps): Bump @graphql-tools/graphql-file-loader from 7.3.11 to 7.3.12 by @dependabot in #522
📦 npm(deps): Bump @graphql-tools/load from 7.5.10 to 7.5.11 by @dependabot in #525
✨ add doc options support by @edno in #528

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.9.3...1.10.0

1.9.3 - 14 Apr 2022

What's Changed

📦 npm(deps): bump @graphql-tools/load from 7.5.3 to 7.5.5 by @dependabot in #487
📦 npm(deps): bump @graphql-tools/graphql-file-loader from 7.3.5 to 7.3.7 by @dependabot in #484
📦 npm(deps): Bump @graphql-tools/load from 7.5.5 to 7.5.6 by @dependabot in #488
📦 npm(deps): Bump ansi-regex from 3.0.0 to 3.0.1 by @dependabot in #491
📦 npm(deps): Bump @graphql-inspector/core from 3.1.1 to 3.1.2 by @dependabot in #490
♻️ code refactoring by @edno in #492
🐛 remove blank line from code block by @edno in #498
📦 update dependencies by @edno in #500
📦 npm(deps): Bump @graphql-tools/graphql-file-loader from 7.3.8 to 7.3.9 by @dependabot in #505
📦 npm(deps): Bump @graphql-tools/load from 7.5.7 to 7.5.8 by @dependabot in #506

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.9.2...1.9.3

1.9.2 - 25 Mar 2022

What's Changed

📝 move online docs to dedicated repo by @edno in #475
🐛 update so the keyword input displays by @coder2034 in #480

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.9.1...1.9.2

1.9.1 - 20 Mar 2022

No functional changes in the package, only repo location changed to https://github.com/graphql-markdown/graphql-markdown.

What's Changed

📦 add commitizen by @elias-pap in #465
🧑‍💻 move repo to graphql-markdown org by @edno in #470
📝 fix Docusaurus links by @edno in #473

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.9.0...1.9.1

1.9.0 - 13 Mar 2022

This version comes with plugin multi-instance support, by @elias-pap. You can read more about it in the documentation.

What's Changed

feat: add multi-instance support by @elias-pap in #449
Update github actions workflows by @edno in #455
code refactoring by @edno in #459
test: improve coverage by @elias-pap in #460
docs(README.md): add multi-instance usage by @elias-pap in #462
add pr template by @edno in #464

New Contributors

@elias-pap made their first contribution in #449

Full Changelog: https://github.com/edno/graphql-markdown/compare/1.8.5...1.9.0

1.8.5 - 24 Feb 2022

What's Changed

Fix compilation error for @specifiedBy directives by adding a newline by @jlndk in #447

New Contributors

@jlndk made their first contribution in #447

Full Changelog: https://github.com/edno/graphql-markdown/compare/1.8.4...1.8.5

1.8.4 - 21 Feb 2022

You can now try GraphQL Markdown with our live sandbox.

What's Changed

Improve schema index page by @edno in #446

Full Changelog: https://github.com/edno/graphql-markdown/compare/1.8.3...1.8.4

1.8.3 - 17 Feb 2022

What's Changed

Fix: apply groupByDirective option from config file by @davidyaha in #442

New Contributors

@davidyaha made their first contribution in #442

Full Changelog: https://github.com/edno/graphql-markdown/compare/1.8.2...1.8.3

1.8.2 - 15 Jan 2022

Fix NPM package containing extra files (no code change)

1.8.1 - 15 Jan 2022

What's Changed

fix hasPrettierModule by @edno in #427

Full Changelog: https://github.com/edno/graphql-markdown/compare/1.8.0...1.8.1

1.8.0 - 15 Jan 2022

The package continues shrinking by size and by number of dependencies.

Source: Bundlephobia

What's Changed

remove picocolors dependency by @edno in #422
prettier as optional peer dependency by @edno in #423

Maintenance

fix sonarcloud code smells by @edno in #402
fix smoke test failing on node warning by @edno in #415
fix docker command for running demo by @edno in #424
update package.json entries by @edno in #426
update package dependencies by @edno in #425

Full Changelog: https://github.com/edno/graphql-markdown/compare/1.7.0...1.8.0

1.7.0 - 21 Nov 2021

Breaking change ⚠️

GraphQL package is now a peer dependency by @edno in #399

You need to add graphql dependency to your project if not already installed.

Full Changelog: https://github.com/edno/graphql-markdown/compare/1.6.0...1.7.0

1.6.0 - 16 Nov 2021

This version comes with a new feature for grouping documentation using GraphQL directives, by @coder2034. You can read more about it in the documentation, and you can see a demo here.

What's Changed

add feature for grouping by category by @coder2034 in #358
fix pages count in summary by @edno in #375
add contributing guidelines by @edno in #379

New Contributors

@coder2034 made their first contribution in #358

Full Changelog: https://github.com/edno/graphql-markdown/compare/1.5.4...1.6.0

1.5.4 - 25 Oct 2021

What's Changed

Fix missing generated.md (#371) by @edno in #372

Full Changelog: https://github.com/edno/graphql-markdown/compare/1.5.3...1.5.4

1.5.3 - 24 Oct 2021

🔴 The package is missing assets/generated.md, this can be fixed using the homepage option and downloading the missing file here. (#371)

What's Changed

Add options customization in loaders by @GuiHash in #365

Maintenance

Fix actions not triggered for external PRs by @edno in #359
Remove lodash and slugify dependencies by @edno in #361
Remove nyc, npm and yarn from dev dependencies by @edno in #364
Reduce Jest memory usage by @edno in #363

New Contributors

@GuiHash made their first contribution in #365

Full Changelog: https://github.com/edno/graphql-markdown/compare/1.5.1...1.5.3

1.5.1 - 19 Oct 2021

What's Changed

Fix MDX renderer error with curly braces by @edno in #356

Full Changelog: https://github.com/edno/graphql-markdown/compare/1.5.0...1.5.1

1.5.0 - 09 Oct 2021

💥 BREAKING CHANGE💥

Starting version 1.5.0, docusaurus2-graphql-doc-generator only provides graphql-file-loader document loader out-of-the-box. Thus, by default, the schema default loading expects a local GraphQL schema definition file (*.graphql).

See loaders option documentation in README file.

For a full compatibility with previous versions, add the following packages to your Docusaurus project:

yarn add @graphql-tools/url-loader @graphql-tools/json-file-loader

Once installed, you can declare both loaders into docusaurus2-graphql-doc-generator configuration:

plugins: [
  [
    '@edno/docusaurus2-graphql-doc-generator',
    {
      //... existing configuration
      loaders: {
        UrlLoader: "@graphql-tools/url-loader",
        JsonFileLoader: "@graphql-tools/json-file-loader"
      }
    },
  ],
]

Note, you don't need to re-declare graphql-file-loader since it is provided out-of-the-box.

Why this change?

There are several reasons behing this change:

Reducing dependencies footprint and management

More flexibility as more GraphQL document loaders become available

Preparation work for version 2.0

Other changes

More dependencies removed: moment, chalk (replaced by picocolors), colors (replaced by picocolors).

1.4.3 - 04 Oct 2021

Technical maintenance:

Improve devx (CI, testing)
Update dependencies
Remove extra files from package (reduced size by about 5kB)

1.4.2 - 09 Sep 2021

Reduce the size of the package from 348 kB to 44.6 kB.

1.4.1 - 06 Sep 2021

Fix issues with Windows OS (#201, #287, #288).

1.4.0 - 15 Aug 2021

@jineshshah36 spotted a bug (#234) and submitted a fix that was worth another release 😃

Fix default value handling for Int when not set (#235 by @jineshshah36)
Upgrade graphql-tools to version 7.

1.3.1 - 04 Aug 2021

Fix 1.3.0 packaging issue (missing files #254 reported by @dkershner6)

1.3.0 - 12 Jul 2021

BROKEN PACKAGE FIXED IN 1.3.1

~~This is the last release for the version 1 (a beta for the version 2 will be soon release).~~

move from plugin generated toolbar to Docusaurus auto-generated toolbar
fix some async issues that may cause the server to crash when starting
dependencies updates

⚠️ If you use a custom homepage (see options), then you will need to add the metadata sidebar_position: 1 to ensure that it is shown at the top of the sidebar (see README).

1.2.2-beta - 02 Jun 2021

Fix #223 where @specifiedBy MDX was breaking Docusaurus parser.

Fix homepage slug that was not set properly (please open an issue if this impacts your current setup).

1.2.1-beta - 29 May 2021

Remove unused dependency

1.2.0-beta - 13 May 2021

Add support of the directive specifiedBy for type scalar

Update display of the directive @deprecated using Docusaurus CSS instead of custom React component

Before	After

1.1.1-beta - 10 May 2021

Upgrade dependencies.

1.1.0-beta - 15 Nov 2020

Added support for @deprecated types and fields.

1.0.0-beta - 24 Oct 2020

1.0.0 (beta) is ready for use 🎉

For a local demo, you can clone this repository and run the demo command:

git clone https://github.com/edno/docusaurus2-graphql-doc-generator.git
yarn
yarn demo

Then open the URL http://localhost:8080/docs/schema in your browser 🚀

0.4.1-alpha - 29 Sep 2020

Add digits support in filename (#63 by @jocrau)

0.4.0-alpha - 31 Jul 2020

Fix issue when documents are not under root location (new parameter linkRoot)
Documentation generation can be forced with the flag -f (--force).

All parameters are now switched to flags (see doc).

0.3.1-alpha - 30 Jun 2020

Changes

Files generated by diffMethod moved into OS temp folder (by default)
tmpDir parameter for overriding the folder location for files generated by diffMethod

0.3.0-alpha - 27 Jun 2020

Change

Option diffMethod for choosing the diff method to be used for identifying schema change

Fix

Fix Docusaurus crash when the documentation is regenerated

0.2.1-alpha - 27 Jun 2020

Fix crash due to extra await (144e46d756)

0.2.0-alpha - 27 Jun 2020

Changes

Output folder is emptied before generating doc preventing outdated pages to be left in the folder (fae474252e)
Add a diff mechanism based on schema SHA-256 hash preventing generation of doc when the schema is unchanged (d837a2352c)

0.1.0-alpha - 14 Jun 2020