@graphql-markdown/docusaurus - npm Package Versions

1.24.0 - 2024-02-19

:robot: 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.

What's Changed

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

[Changes][1.24.0]

<a id="1.23.0"></a>

1.23.0 - 2024-02-10

:sparkle: 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.

What's changed

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

[Changes][1.23.0]

<a id="1.22.0"></a>

1.22.0 - 2023-12-27

🧑‍🔧 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
          },
        },
      },
    ],
  ],

[DEPRECATED] 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

[Changes][1.22.0]

<a id="1.21.3"></a>

1.21.3 - 2023-11-24

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

What's Changed

1.21.2 - 2023-11-22

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

| Docusaurus 2 | Docusaurus 3 | |---|---| |<code>:::caution DEPRECATED</code>|<code>:::warning[DEPRECATED]</code>|

What's Changed

1.21.1 - 2023-11-05

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

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

What's Changed

1.21.0 - 2023-09-30

🚀 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

[Changes][1.21.0]

<a id="1.20.4"></a>

1.20.4 - 2023-08-07

:technologist: Technical release to freeze the last JS changes before the migration of the code to TS.

What's Changed

1.20.3 - 2023-07-19

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

• Before fix :disappointed:

• After fix :grinning:

What's Changed