Skip to content

Update dependency @graphql-markdown/docusaurus to v1.26.2

Renovate requested to merge renovate/graphql-markdown-docusaurus-1.x-lockfile into main

This MR contains the following updates:

Package Type Update Change
@graphql-markdown/docusaurus (source) dependencies minor 1.20.4 -> 1.26.2

Release Notes

graphql-markdown/graphql-markdown (@​graphql-markdown/docusaurus)

v1.26.2

Compare Source

🐛 This release fixes [ERROR] Error: Cannot find module '@​graphql-markdown/printer-legacy'. dependency package reported by @​mderriey in #​1691.

What's Changed

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.26.0...1.26.2

[Changes][1.26.2]

v1.26.0

Compare Source

❇ You can now generate the documentation using a flat files structure (single folder), provided by the option printTypeOptions.hierarchy. The option also deprecates the option printTypeOptions.useApiGroup (more information in the documentation).

Screenshot 2024-08-03 at 12 17 47

:magic_wand: With the option printTypeOptions.hierarchy, you can also now rename the top categories when using api hierarchy (more information in the documentation).

⚠️ BREAKING CHANGE - When using api hierarchy, the top categories are now Operations and Types instead of Api and Types. The option printTypeOptions.hierarchy allows backward compatibility (more information in the documentation).

🥚 This release also introduces the force parameter that ensures the target folder is empty before generating the documentation (more information in the documentation).

What's Changed

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.25.0...1.26.0

[Changes][1.26.0]

v1.25.0

Compare Source

⚠ BREAKING CHANGE - This release removes sidebars files generation. The sidebars now rely on the Docusaurus default sidebar behavior.

What's Changed

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.24.4...1.25.0

[Changes][1.25.0]

v1.24.4

Compare Source

🐛 Generated links now follow Docusaurus recommended practices to link docs by file path. This fix adds the .mdx extension to generated links in Markdown files.

🐰 A CodeSandox demo using Docusaurus versioning is available here: https://codesandbox.io/p/devbox/determined-spence-mrpnmp

What's Changed

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.24.3...1.24.4

[Changes][1.24.4]

v1.24.3

Compare Source

🐛 This release removes the use of block quotes for type description, fixing issues like #​1535

What's Changed

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.24.2...1.24.3

[Changes][1.24.3]

v1.24.2

Compare Source

🔧 Technical maintenance release for dependencies upgrades.

⚠️ This version removes compatibility with the graphql package version below 16 (see issue https://github.com/graphql-markdown/graphql-markdown/issues/1458).

What's Changed

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

[Changes][1.24.2]

v1.24.1

Compare Source

What's Changed

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

[Changes][1.24.1]

v1.24.0

Compare Source

🤖 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
Screenshot from 2024-02-19 18-38-20 Screenshot from 2024-02-19 18-38-37

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]

v1.23.0

Compare Source

❇ 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).

Screenshot from 2024-02-10 16-37-28

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]

v1.22.0

Compare Source

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

v1.21.3

Compare Source

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

What's Changed

@​graphql-markdown/docusaurus@​1.21.3
@​graphql-markdown/core@​1.7.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

[Changes][1.21.3]

v1.21.1

Compare Source

🚀 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
@​graphql-markdown/core@​1.7.1
@​graphql-markdown/helpers@​1.0.1
@​graphql-markdown/graphql@​1.0.1
@​graphql-markdown/printer-legacy@​1.5.1
@​graphql-markdown/diff@​1.1.1
@​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

[Changes][1.21.1]

v1.21.0

Compare Source

🚀 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]

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this MR and you won't be reminded about this update again.

  • If you want to rebase/retry this MR, check this box

This MR has been generated by Renovate Bot.

Edited by Renovate

Merge request reports