Docusaurus文档工具站

template (graphql-markdown) — Docusaurus 文档模板

作者 graphql-markdown

基于 Docusaurus 的 GraphQL-Markdown 文档模板，用 .graphqlrc 配置 GraphQL schema 来源并生成 API 文档站点。

打开源站下载源码 ZIP

看看你的网站会是什么样

浏览真实页面截图，比较内容排版与手机效果。点击下方缩略图切换，放大查看整页细节。

2 个预览视图

桌面端首页1 / 2

访问演示网站在新标签页打开

桌面端截图首屏预览

由服务器浏览器实际访问页面后截取。

全部页面与视图 2

截图用于了解视觉与布局，交互效果请以实际项目为准。

采集于 2026-10-01查看来源

值得关注的模板亮点

从已有项目资料中，快速了解它的特点。

Docusaurus 模板，面向 GraphQL-Markdown 的文档生成流程

通过 .graphqlrc 声明 schema 来源与 graphql-markdown 扩展选项

支持 UrlLoader 从远程 GraphQL 端点加载 schema

可配置 baseURL、静态首页文件与 frontMatter 分页字段

提供 npm run doc 生成文档、npm start 启动站点的脚本流程

模板详细介绍

这是 GraphQL-Markdown 官方提供的 Docusaurus 模板，用于搭建以 GraphQL schema 为内容来源的文档站点。模板本身不包含业务页面，而是把 Docusaurus 与 GraphQL-Markdown 的文档生成流程组合起来：在 .graphqlrc 中声明 schema 地址与 graphql-markdown 扩展选项，再通过 npm run doc 生成文档，最后由 npm start 启动本地站点。

配置项覆盖了模板的主要可变部分。schema 可指向远程 GraphQL 端点（示例使用 countries.trevorblades.com/graphql），扩展中可设置 baseURL、homepage 指向的静态首页文件、UrlLoader 模块及请求方式、docOptions.frontMatter 中的分页字段，以及 printTypeOptions.deprecated 对废弃字段的处理方式。

使用限制方面，模板依赖 GraphQL-Markdown 及其 loader 生态，schema 获取方式与生成结果受 .graphqlrc 配置约束；仓库 README 只给出安装、配置、生成、启动四步，未说明主题定制、多 schema 或部署细节，这些需要结合 GraphQL-Markdown 与 Docusaurus 各自的文档处理。

Docusaurus文档工具站

适合你的项目吗？

适用场景

为已有 GraphQL API 生成可浏览的类型与字段文档
把远程 GraphQL schema 转成 Docusaurus 站点中的 Markdown 文档
在 Docusaurus 项目中试验 GraphQL-Markdown 的配置项与输出效果

适合人群

需要为 GraphQL schema 建立文档站点的开发者
使用 Docusaurus 并希望接入 GraphQL-Markdown 的团队
想参考官方模板配置 .graphqlrc 与文档生成脚本的用户

上手与定制指南

结合仓库当前版本的说明，按下面的资料检查内容、配置与运行要求。

1
使用 npm init docusaurus my-website https://github.com/graphql-markdown/template.git 创建项目
2
在 .graphqlrc 中设置 schema 地址与 graphql-markdown 扩展选项
3
运行 npm run doc 生成文档，再运行 npm start 启动本地站点
4
示例 schema 指向公开的 countries GraphQL 端点，可替换为自己的 schema 来源

查看仓库使用说明

授权与来源资料

使用条件与限制

免费使用 · 保留许可声明

本次收录的是公开仓库中采用 MIT 许可的免费版本；免费范围为该版本代码，不代表外部服务或第三方素材免费。

使用时需要遵守

允许免费使用、修改、商用和分发该版本代码。
分发代码副本或实质性部分时，保留原作者版权声明和完整 MIT 许可声明。
代码按现状提供；担保与责任限制以原许可证及适用法律为准。

额外费用与待核对事项

示例配置默认从远程 GraphQL 端点 countries.trevorblades.com/graphql 获取 schema，需联网访问该外部服务；实际使用时须替换为自己的 schema 来源。
创建项目依赖 npm 与 Docusaurus 脚手架，并从 GitHub 拉取模板仓库，需要可用的 Node.js/npm 环境与网络连接。
UrlLoader 依赖 @graphql-tools/url-loader 模块加载远程 schema，需安装该依赖并按其选项配置请求方式。
演示图片、字体、图标及其他第三方素材需按各自许可核对，不能仅凭代码的 MIT 许可判断。
域名、托管、数据库、支付或 AI 等外部服务可能另外收费。

查看原文依据

Permission is hereby granted, free of charge
许可证原文

schema: 'https://countries.trevorblades.com/graphql'
README 原文

npm init docusaurus my-website https://github.com/graphql-markdown/template.git
README 原文

module: '@graphql-tools/url-loader'
README 原文

https://github.com/graphql-markdown/template/blob/main/LICENSE https://github.com/graphql-markdown/template/blob/main/README.md

DeepSeek 根据仓库许可证和 README 整理 ·2026-10-01。结果仅覆盖已读取资料，依赖、图片、字体及后续条款变更以各自原文为准。

项目核对记录与介绍依据

模板资料

来源平台: GitHub
资料与维护参考分: 资料较完整 · 88 / 100
技术栈: Docusaurus
网站类型: 文档 · 工具站

这个分数如何计算

本站按许可资料（最高30分）、演示链接（12分）、预览图（10分）、Star数（15分）、记录的维护时间（15分）、描述完整度（8分）、功能记录（5分）和分类资料（5分）计算。它不是代码、安全或性能测试，也不是 Google 评分；有链接不代表已实测可用。

这个项目需要核对什么

记录的仓库更新时间: 2026-09-26
截图检查日期: 2026-10-01

已收录演示链接。请用你的内容与屏幕尺寸检查；有演示不代表表单、认证或支付已经可用。

目录记录的主要技术栈是 Docusaurus。请通过依赖清单和锁文件核对实际版本与托管要求。这些说明基于收录资料，不代表代码审计或部署实测。

查看具体选型方法 →

介绍的制作与核对状态

介绍由 AI 辅助整理目录与仓库资料。仓库作者不等于这篇介绍的审核者。

已完成服务器许可规则与 AI 来源核对；未经过人工编辑审核。

查看当时使用的来源资料

SHA-256: afc168d1d76b6bedc48c440fa08dbc2fe5afc0e70c9b7fd4f00835e1eaf0c206

2026-10-01T03:43:41.493Z

来源文件 / 仓库

# GraphQL-Markdown template

Docusaurus template for [GraphQL-Markdown](https://graphql-markdown.dev).

## Quick start

### 1. Install

```shell
npm init docusaurus my-website https://github.com/graphql-markdown/template.git
```

### 2. Configure

Update settings in `.graphqlrc` (see [documentation](https://graphql-markdown.dev/docs/configuration#graphql-config)).

```yaml
schema: 'https://countries.trevorblades.com/graphql'
extensions:
  graphql-markdown:
    baseURL: '.'
    homepage: 'static/index.md'
    loaders:
      UrlLoader: 
        module: '@graphql-tools/url-loader'
        options:
          method: 'POST'
    docOptions:
      frontMatter:
        pagination_next: null
        pagination_prev: null
    printTypeOptions:
      deprecated: 'group'
```

### 3. Generate

```shell
npm run doc
```

### 4. Start

```shell
npm start
```

反馈内容错误