@ graphql- markdown/ docusaurus (缩写)

多龙 文档特性 生成插件 标记下文档 从a 图QL 方案。 。 。 .
安装
npm create graphql-markdown-docs@latest -- --framework docusaurus
如果您已有 Docusaurus 安装, 请查看 文档 备选案文.
使用量
插件添加了新命令 graphql-to-doc 页:1 多龙 CLI。 。 。 .
npx docusaurus graphql-to-doc
命令行选项在 文档设置 页 次.
配置
见 文档设置 页 次.
解决问题
见 文档排除出错 页 次.
许可证
GraphQL-Markdown 软件包是100%的自由和开源软件,在 麻省理工学院许可证。 。 。 .
这个软件包是 树件如果你把它用于生产,那么我们要求你 给世界买一棵树 感谢我们的工作。 通过为"树地"森林做贡献,你们将为当地家庭创造就业机会并恢复野生动物栖息地.
关于 @graphql-markdown/docusaurus 的常见问题
@graphql-markdown/docusaurus 是什么?
从 GraphQL 计划生成 Markdown 文档的 Docusaurus 插件 .
如何安装 @graphql-markdown/docusaurus?
在项目目录运行 npm install @graphql-markdown/docusaurus,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@docusaurus/logger(*)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。
@graphql-markdown/docusaurus 支持 TypeScript 吗?
支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。
@graphql-markdown/docusaurus 支持 ESM 还是 CommonJS?
同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。
@graphql-markdown/docusaurus 需要什么版本的 Node.js?
package.json 的 engines 字段要求 Node.js >=22.18.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。
@graphql-markdown/docusaurus 可以商用吗?
@graphql-markdown/docusaurus 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。
@graphql-markdown/docusaurus 的下载量有多少?
根据 npm 官方下载统计,@graphql-markdown/docusaurus 在 2026/10/17 – 2026/11/15 这 30 天内被下载 72,768 次,日均约 2,426 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。
@graphql-markdown/docusaurus 还在维护吗?
最新版本 1.39.2 发布于 2026/11/15(1 天前);至今共发布 67 个版本,其中过去 12 个月发布了 17 个;首次发布于 2022/10/05。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。