https://github.com/graphql-markdown/demo-mkdocs
GraphQL-Markdown + MkDocs demo
https://github.com/graphql-markdown/demo-mkdocs
documentation documentation-generator graphql markdown mkdocs readthedocs
Last synced: 1 day ago
JSON representation
GraphQL-Markdown + MkDocs demo
- Host: GitHub
- URL: https://github.com/graphql-markdown/demo-mkdocs
- Owner: graphql-markdown
- Created: 2026-04-23T18:00:22.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2026-05-31T17:14:18.000Z (25 days ago)
- Last Synced: 2026-05-31T18:21:07.987Z (25 days ago)
- Topics: documentation, documentation-generator, graphql, markdown, mkdocs, readthedocs
- Language: JavaScript
- Homepage: https://graphql-markdown.dev/
- Size: 2.65 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GraphQL-Markdown + MkDocs demo
This project demonstrates how to generate GraphQL documentation with GraphQL-Markdown for a MkDocs site using the Read the Docs theme.
**Live demo:** [graphql-markdown.dev/demo-mkdocs](https://graphql-markdown.dev/demo-mkdocs/)
## Quick start
```bash
npm install
npm run dev
```
Open `http://127.0.0.1:8000/` and use the GraphQL API entry in the navigation.
## Project structure
```text
.
├── docs/
│ ├── graphql/ # Generated GraphQL documentation
│ ├── index.md # Demo home page
│ └── stylesheets/
│ └── gqlmd.css # Badge styling
├── schema.graphql # Sample GraphQL schema
├── scripts/
│ ├── custom-mkdocs-mdx.mjs # Wrapper that extends the MkDocs preset with section index links
│ └── generate-docs.mjs # GraphQL-Markdown runner
├── theme-overrides/
│ └── footer.html # Read the Docs theme footer override
├── mkdocs.yml # MkDocs configuration
└── package.json
```
## Notes
- The preset `@graphql-markdown/formatters/mkdocs` now provides:
- Visible page titles as `# H1` headings
- HTML `` collapsible blocks
- Post-render internal link rewriting to page-relative `.md` links
- The demo wrapper keeps one demo-specific behavior: appending generated entity links to per-section `index.md` files.
- The Read the Docs footer attribution is overridden through `theme-overrides/footer.html`.