@graphql-markdown/docusaurus
Advanced tools
Changelog
1.26.3 - 2024-11-14
🐛 This releases fixes graphql-markdown logs not being reported to Docusaurus 3.
Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.26.2...1.26.3
[Changes][1.26.3]
<a id="1.26.2"></a>
Changelog
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.
Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.26.0...1.26.2
[Changes][1.26.2]
<a id="1.26.0"></a>
Changelog
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).
Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.25.0...1.26.0
[Changes][1.26.0]
<a id="1.25.0"></a>
Changelog
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.
Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.24.4...1.25.0
[Changes][1.25.0]
<a id="1.24.4"></a>
Changelog
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
Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.24.3...1.24.4
[Changes][1.24.4]
<a id="1.24.3"></a>
Changelog
1.24.2 - 2024-06-23
🔧 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).
Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.24.1...1.24.2
[Changes][1.24.2]
<a id="1.24.1"></a>
Changelog
1.24.1 - 2024-04-19
Full Changelog: https://github.com/graphql-markdown/graphql-markdown/compare/1.24.0...1.24.1
[Changes][1.24.1]
<a id="1.24.0"></a>
Changelog
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.
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>