✨ The framework independent package cli is slowly maturing. It is now the backbone of the docusaurus package. From now, it should be possible to create customized MDX formatter for Next.js, Gatsby, Astro... using the undocumented setting mdxParser. For more information and examples, see the docusaurus package's source code.

🔧 This release also comes with a tiny new CLI flag --config that will print the processed configuration into a JSON format. This can be handy while debugging some of the customization, especially when mixing CLI and GraphQL Config settings.

What's Changed

📦 fix(deps): update graphql-tools monorepo by @renovate in #1976
:sparkle: docusaurus plugin extends cli package by @edno in #1982
📦 fix(deps): update graphql-tools monorepo by @renovate in #1989
📄 Fix showcase Saleor typo by @krzysztofzuraw in #1991
📦 fix(deps): update graphql-tools monorepo by @renovate in #1999
✨ isolate mdx by @edno in #2000
📦 fix(deps): update graphql-tools monorepo by @renovate in #2012
📦 fix(deps): update graphql-tools monorepo by @renovate in #2014
:sparkles: add cli support for external mdx package by @edno in #2017
:construction_worker: fix packages api docs generation by @edno in #2021
:wrench: fix api doc generation issue by @edno in #2025
🐛 fix docusaurus mdx external module by @edno in #2023

New Contributors

@krzysztofzuraw made their first contribution in #1991

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.27.0...1.28.8

[Changes][1.28.0]

1.27.0

Diff

edno

published 1.27.0 • 4 months ago

Changelog

Source

1.27.0 - 2025-02-16

🚀 This release introduces a new NodeJS command line package @graphql-markdown/cli allowing generation of Markdown files without Docusaurus dependencies. This is still an early release and it is not yet documented, but you can experiment with it and give your feedback on this new package when used with other static site generators - note that you'll need MDX support.

Install npm install @graphql-markdown/cli
Usage npx gqlmd graphql-to-doc

ℹ️ The cli package works similarly to the Docusaurus plugin, but it relies on a GraphQL config file for the settings. You can find examples of settings in the test folder of the package.

⚠️ BREAKING CHANGES - All previously deprecated settings have been removed:

docOptions.pagination | --noPagination (deprecated in release 1.22.0)
docOptions.toc | --noToc (deprecated in release 1.22.0)
printTypeOptions.useApiGroup | --noApiGroup (deprecated in release 1.26.0)

What's Changed

✨ generic cli package by @edno in #1959
:sparkles: move docusaurus\utils from printer to docusaurus plugin by @edno in #1962
:sparkles: remove deprecated settings by @edno in #1964

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.26.4...1.27.0

[Changes][1.27.0]

1.26.4

Diff

edno

published 1.26.4 • 5 months ago

Changelog

Source

1.26.4 - 2024-12-22

🐛 This release adds fixes for printTypeOptions parameters hierarchy and exampleSection.

What's Changed

♻️ remove circular dependencies in #1820
:bug: fix error when hierarchy is defined in CLI but validation failed against default value in #1884
🐛 fix error with example option when a schema contains recursive types in #1887, reported by @TurkeyMcGuyver in #1883

Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.26.3...1.26.4

[Changes][1.26.4]

1.26.3

Diff

edno

published 1.26.3 • 7 months ago

Changelog

Source

1.26.3 - 2024-11-14

🐛 This releases fixes graphql-markdown logs not being reported to Docusaurus 3.

What's Changed

:bug: fix dynamic import for logger packages by @edno in #1802
📦 fix(deps): update graphql-tools monorepo by @renovate in #1801
📦 fix(deps): update dependency @graphql-inspector/core to v6.2.0 by @renovate in #1799

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

[Changes][1.26.3]

1.26.2

Diff

edno

published 1.26.2 • 9 months ago

Changelog

Source

1.26.2 - 2024-09-06

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

What's Changed

:bug: fix missing dependency printer-legacy by @edno in #1692

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

[Changes][1.26.2]

1.26.0

Diff

edno

published 1.26.0 • 10 months ago

Changelog

Source

1.26.0 - 2024-08-14

💥 MISSING DEPENDENCY (#1691) FIXED IN RELEASE 1.26.2 💥

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

: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

📝 add warning upgrade 1.3.0 in docs by @edno in #1602
✨ add parameter to force empty output folder by @edno in #1608
✨ add support for custom useApiGroup groups name by @edno in #1609
:recycle: replace deprecated fs.rmdir by fs.rm by @edno in #1610
✨ support flat files structure by @edno in #1622

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

[Changes][1.26.0]

1.25.0

Diff

edno

published 1.25.0 • 10 months ago

Changelog

Source

1.25.0 - 2024-07-26

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

What's Changed

✨ remove sidebar file generation by @edno in #1596

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

[Changes][1.25.0]

1.24.4

Diff

edno

published 1.24.4 • 11 months ago

Changelog

Source

1.24.4 - 2024-07-20

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

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