@graphql-markdown/core

中文文档
1.26.1发布于 2026/11/15MITTypeScriptESM + CJS构建来源已验证近 30 天下载 9.7万

Core of GraphQL-Markdown: generates Markdown documentation from a GraphQL schema.

原始使用文档
文档目录5 节
  1. Installation
  2. Usage
  3. Event system
  4. Documentation
  5. License

@graphql-markdown/core

Latest Version JSR GitHub License Technical Debt Coverage Mutation Score

Core engine for generating Markdown documentation from a GraphQL schema. It orchestrates schema loading, diffing, rendering, and the event lifecycle used by @graphql-markdown/cli and @graphql-markdown/docusaurus. Most users should install one of those packages instead of depending on core directly.

Installation

npm install @graphql-markdown/core

Usage

import { buildConfig, generateDocFromSchema } from "@graphql-markdown/core";

const config = await buildConfig({
  schema: "./schema.graphql",
  rootPath: "./docs",
  baseURL: "api",
});

await generateDocFromSchema(config);

Event system

core exposes a cancellable event emitter so that formatters, printers, and custom scripts can hook into schema loading, diff checks, and rendering:

import { getEvents, SchemaEvents } from "@graphql-markdown/core";

getEvents().on(SchemaEvents.AFTER_LOAD, (event) => {
  console.log("Schema loaded", event);
});

See the hooks recipes for the full list of lifecycle events and their payloads.

Documentation

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.

版本与发布记录

@graphql-markdown/core 共发布 64 个版本,首次发布于 2022/10/23;过去 12 个月发布了 17 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
1.26.1latest2026/11/151 天前
1.26.02026/10/3018 天前
1.25.02026/10/131 个月前
1.24.12026/10/101 个月前
1.24.02026/10/091 个月前
1.23.02026/09/181 个月前

关于 @graphql-markdown/core 的常见问题

@graphql-markdown/core 是什么?

Core of GraphQL-Markdown: generates Markdown documentation from a GraphQL schema.

如何安装 @graphql-markdown/core?

在项目目录运行 npm install @graphql-markdown/core,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:graphql(^16.0.0 || ^17.0.0)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。

@graphql-markdown/core 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@graphql-markdown/core 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@graphql-markdown/core 需要什么版本的 Node.js?

package.json 的 engines 字段要求 Node.js >=22.18.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。

@graphql-markdown/core 可以商用吗?

@graphql-markdown/core 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@graphql-markdown/core 的下载量有多少?

根据 npm 官方下载统计,@graphql-markdown/core 在 2026/10/17 – 2026/11/15 这 30 天内被下载 97,031 次,日均约 3,234 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@graphql-markdown/core 还在维护吗?

最新版本 1.26.1 发布于 2026/11/15(1 天前);至今共发布 64 个版本,其中过去 12 个月发布了 17 个;首次发布于 2022/10/23。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。