@graphql-markdown/docusaurus

@graphql-markdown/docusaurus

Docusaurus docs feature plugin for generating Markdown documentation from a GraphQL schema.

Installation

graphql package is a peer-dependency, and it should be installed separately.

npm install @graphql-markdown/docusaurus graphql

Add @graphql-markdown/docusaurus to your site's docusaurus.config.js plugins option:

module.exports = {
  // ...
  plugins: ["@graphql-markdown/docusaurus"],
};

Usage

The plugin adds a new command graphql-to-doc to the Docusaurus CLI.

npx docusaurus graphql-to-doc

Command line options are described in the documentation settings page.

Configuration

See documentation settings page.

Troubleshooting

See documentation troubleshooting page.

License

GraphQL-Markdown packages are 100% free and open-source, under the MIT license.

This package is Treeware. If you use it in production, then we ask that you buy the world a tree to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.

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

<img width="1049" alt="Screenshot 2024-08-03 at 12 17 47" src="https://github.com/user-attachments/assets/b2d41d8b-efca-4e2d-8ac7-d685c26d7b4c">

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

<a id="1.25.0"></a>