https://github.com/graphql-markdown/demo-mdbook
GraphQL-Markdown + mdBook demo
https://github.com/graphql-markdown/demo-mdbook
documentation documentation-generator graphql markdown mdbook
Last synced: 1 day ago
JSON representation
GraphQL-Markdown + mdBook demo
- Host: GitHub
- URL: https://github.com/graphql-markdown/demo-mdbook
- Owner: graphql-markdown
- Created: 2026-04-23T18:03:07.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2026-05-31T17:15:44.000Z (26 days ago)
- Last Synced: 2026-05-31T18:18:48.229Z (26 days ago)
- Topics: documentation, documentation-generator, graphql, markdown, mdbook
- Language: JavaScript
- Homepage: https://graphql-markdown.dev/
- Size: 1.05 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GraphQL-Markdown + mdBook demo
This project demonstrates how to generate GraphQL documentation with GraphQL-Markdown for an mdBook site.
**Live demo:** [graphql-markdown.dev/demo-mdbook](https://graphql-markdown.dev/demo-mdbook/)
## Quick start
```bash
npm install
npm run dev
```
Open `http://127.0.0.1:3000/` and use the GraphQL API entry in the navigation.
## Project structure
```text
.
├── src/
│ ├── graphql/ # Generated GraphQL documentation
│ ├── introduction.md # Demo home page
│ └── SUMMARY.md # mdBook table of contents
├── schema.graphql # Sample GraphQL schema
├── scripts/
│ ├── custom-mdbook-mdx.mjs # Wrapper that extends the mdBook preset
│ └── generate-docs.mjs # GraphQL-Markdown runner
├── theme/
│ └── github-dark-dimmed.min.css # Custom dark theme
├── book.toml # mdBook configuration
└── package.json
```
## Notes
- The preset `@graphql-markdown/formatters/mdbook` provides mdBook-compatible Markdown output.
- The demo wrapper in `scripts/custom-mdbook-mdx.mjs` extends the preset with project-specific behavior.
- The `src/SUMMARY.md` is updated automatically by the generator to include generated pages.