@ graphql- markdown/ 核心

生成核心引擎 标记下文档 从a 图QL 方案它协调了装入、分解、渲染和事件寿命周期 @graphql-markdown/cli 财务报告和审定财务报表 @graphql-markdown/docusaurus大多数用户应安装其中的软件包,而不是依赖 core 直接说.
安装
npm install @graphql-markdown/core
使用量
import { buildConfig, generateDocFromSchema } from "@graphql-markdown/core";
const config = await buildConfig({
schema: "./schema.graphql",
rootPath: "./docs",
baseURL: "api",
});
await generateDocFromSchema(config);
事件系统
core 曝光一个可切换的事件发送器,以便格式化器,打印机和自定义脚本可以钩入到策略加载,diff检查和渲染中:
import { getEvents, SchemaEvents } from "@graphql-markdown/core";
getEvents().on(SchemaEvents.AFTER_LOAD, (event) => {
console.log("Schema loaded", event);
});
见 钩子配方 关于生命周期事件及其有效载荷的完整清单.
文档
许可证
GraphQL-Markdown 软件包是100%的自由和开源软件,在 麻省理工学院许可证。 。 。 .
这个软件包是 树件如果你把它用于生产,那么我们要求你 给世界买一棵树 感谢我们的工作。 通过为"树地"森林做贡献,你们将为当地家庭创造就业机会并恢复野生动物栖息地.
关于 @graphql-markdown/core 的常见问题
@graphql-markdown/core 是什么?
GraphQL-Markdown的核心:从GraphQL schema生成Markdown文档.
如何安装 @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 和提交记录判断。