Docusaurus template oriented toward the GraphQL-Markdown documentation generation workflow
DocusaurusDocumentationTool Site
template (graphql-markdown) — Docusaurus Documentation Template
By graphql-markdown
A Docusaurus-based GraphQL-Markdown documentation template that uses .graphqlrc to configure the GraphQL schema source and generate an API documentation site.
Explore the design
Compare the page layouts and mobile experience. Open any screenshot for a closer look.
Desktop homepage1 / 2
Desktop captureTop of page
Actual screenshot captured by the server browser.
All pages & views 2
Screenshots show visual appearance; interactive behavior may differ.
Recorded 2026-10-01View source
What stands out
A quick read of the recorded project description.
Declare the schema source and graphql-markdown extension options through .graphqlrc
Supports UrlLoader for loading schemas from a remote GraphQL endpoint
Configurable baseURL, static homepage file, and frontMatter pagination field
Provides a script workflow with npm run doc to generate documentation and npm start to launch the site
Template Details
This is the official Docusaurus template provided by GraphQL-Markdown, used to build documentation sites that use a GraphQL schema as their content source. The template itself does not include business pages; instead, it combines Docusaurus with the GraphQL-Markdown documentation generation workflow: declare the schema address and graphql-markdown extension options in .graphqlrc, generate documentation with npm run doc, and finally start the local site with npm start.
The configuration options cover the main variable parts of the template. The schema can point to a remote GraphQL endpoint (the example uses countries.trevorblades.com/graphql). In the extension, you can set baseURL, the static homepage file that homepage points to, the UrlLoader module and request method, the pagination field in docOptions.frontMatter, and how printTypeOptions.deprecated handles deprecated fields.
In terms of usage limitations, the template depends on GraphQL-Markdown and its loader ecosystem, and the schema retrieval method and generated output are constrained by the .graphqlrc configuration. The repository README only gives four steps: install, configure, generate, and start. It does not explain theme customization, multiple schemas, or deployment details; these need to be handled in conjunction with the respective documentation for GraphQL-Markdown and Docusaurus.
DocusaurusDocumentationTool site
Is it right for your project?
Use Cases
- Generate browsable type and field documentation for an existing GraphQL API
- Convert a remote GraphQL schema into Markdown documentation in a Docusaurus site
- Experiment with GraphQL-Markdown configuration options and output in a Docusaurus project
Suitable For
- Developers who need to build a documentation site for a GraphQL schema
- Teams using Docusaurus that want to integrate GraphQL-Markdown
- Users who want to refer to the official template for configuring .graphqlrc and documentation generation scripts
Getting started & customization
Use these recorded setup notes alongside the repository instructions for your chosen version.
- 1
Create the project with npm init docusaurus my-website https://github.com/graphql-markdown/template.git
- 2
Set the schema address and graphql-markdown extension options in .graphqlrc
- 3
Run npm run doc to generate documentation, then run npm start to launch the local site
- 4
The example schema points to the public countries GraphQL endpoint and can be replaced with your own schema source
License & source material
Usage conditions & limitations
Free to use · keep license noticeThis entry covers the free version under the MIT license in the public repository; the free scope is the code of this version and does not mean that external services or third-party assets are free.
Must comply with when using
- Free use, modification, commercial use, and distribution of this version's code are permitted.
- When distributing copies or substantial portions of the code, retain the original author's copyright notice and the full MIT license notice.
- The code is provided as is; warranties and limitations of liability are governed by the original license and applicable law.
Additional costs & items to verify
- The example configuration retrieves the schema from the remote GraphQL endpoint countries.trevorblades.com/graphql by default, requiring network access to that external service; in actual use, you must replace it with your own schema source.
- Creating the project depends on npm and the Docusaurus scaffolding and pulls the template repository from GitHub, requiring a working Node.js/npm environment and network connection.
- UrlLoader depends on the @graphql-tools/url-loader module to load remote schemas; you need to install that dependency and configure the request method according to its options.
- Demo images, fonts, icons, and other third-party assets must be checked against their respective licenses and cannot be judged solely by the code's MIT license.
- External services such as domains, hosting, databases, payments, or AI may incur additional charges.
View Original Text Basis
Permission is hereby granted, free of charge
Original License Text
schema: 'https://countries.trevorblades.com/graphql'
Original README
npm init docusaurus my-website https://github.com/graphql-markdown/template.git
Original README
https://github.com/graphql-markdown/template/blob/main/LICENSEhttps://github.com/graphql-markdown/template/blob/main/README.mdmodule: '@graphql-tools/url-loader'
Original README
Compiled by DeepSeek based on repository license and README ·2026-10-01. Results only cover the materials read; dependencies, images, fonts, and subsequent term changes are subject to their respective original texts.
Project checks & description sources
Template Information
- Source platforms
- GitHub
- Documentation and maintenance reference score
- More documented · 88 / 100
- Technologies
- Docusaurus
- Website type
- Documentation · Tool Site
How this score is calculated
Our heuristic uses license records (up to 30), a demo link (12), a preview (10), stars (15), recorded maintenance (15), description completeness (8), feature records (5) and classification data (5). It is not a code, security or performance test, or a Google score. A link does not establish tested functionality.
What to verify for this project
- Repository update recorded
- 2026-09-26
- Screenshot last checked
- 2026-10-01
A demo link is listed. Check it with your own content and viewport sizes; its presence does not confirm that forms, authentication or payments work.
The catalog identifies Docusaurus as the primary stack. Check the actual dependency manifest and lockfile for versions and hosting requirements. These notes use recorded metadata, not a code audit or a deployment test.
Use a selection guide →How this description was prepared
AI-assisted description based on catalog records and repository material. Repository authors are not automatically the reviewers of this description.
Automatically checked against source and license rules; no manual editorial review.
Inspect the recorded source material
SHA-256: afc168d1d76b6bedc48c440fa08dbc2fe5afc0e70c9b7fd4f00835e1eaf0c206
2026-10-01T03:43:41.493Z
Source file / repository# 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
```
Explore similar templates
Compare previews and descriptions within the same stack and category.
easy-sop-docs
A Docusaurus and React documentation site template for SOPs, runbooks, server descriptions, IT policies, and operations documentation. It includes local search via @easyops-cn/docusaurus-search-local (English and Portuguese, index generated only in production builds) and Mermaid diagrams via @docusaurus/theme-mermaid.
Docusaurus · Documentation
project-documentation-template
An IBM open-source Docusaurus documentation site template for large projects that need standalone documentation pages.
Docusaurus · Documentation
template-docusaurus-docs
A Docusaurus documentation site template from dhub.dev, written in MDX and licensed under MIT. It provides an online preview and runs locally via npm install and npm start.
Docusaurus · Documentation
docusaurus-template
A Docusaurus-based Markdown documentation website template, preconfigured by SRO, with a GitHub Pages deployment workflow. It generates a project via create-docusaurus, provides centralized configuration through docusaurus.config.ts and sidebars.ts, and is licensed under ISC.
Docusaurus · Documentation
docs-site-template
A documentation site template built on the Sovrium configuration-as-code engine, positioned as a Docusaurus alternative.
Docusaurus · Documentation
docusaurus-template
A Docusaurus documentation template using the Bubbletea TUI design system, rendering ADRs in MADR format and RFC 2119 specifications as first-class content with auto-linked ADR references, relationship diagrams, and dual publishing to Gitea Pages and GitHub Pages.
Docusaurus · Documentation