{"id":51117792,"url":"https://github.com/graphql-markdown/demo-mkdocs","last_synced_at":"2026-06-24T23:30:40.718Z","repository":{"id":361654549,"uuid":"1219277928","full_name":"graphql-markdown/demo-mkdocs","owner":"graphql-markdown","description":"GraphQL-Markdown + MkDocs demo","archived":false,"fork":false,"pushed_at":"2026-05-31T17:14:18.000Z","size":2781,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-31T18:21:07.987Z","etag":null,"topics":["documentation","documentation-generator","graphql","markdown","mkdocs","readthedocs"],"latest_commit_sha":null,"homepage":"https://graphql-markdown.dev/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/graphql-markdown.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-23T18:00:22.000Z","updated_at":"2026-05-31T17:14:21.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/graphql-markdown/demo-mkdocs","commit_stats":null,"previous_names":["graphql-markdown/demo-mkdocs"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/graphql-markdown/demo-mkdocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphql-markdown%2Fdemo-mkdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphql-markdown%2Fdemo-mkdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphql-markdown%2Fdemo-mkdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphql-markdown%2Fdemo-mkdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/graphql-markdown","download_url":"https://codeload.github.com/graphql-markdown/demo-mkdocs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphql-markdown%2Fdemo-mkdocs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34753781,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-24T02:00:07.484Z","response_time":106,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","documentation-generator","graphql","markdown","mkdocs","readthedocs"],"created_at":"2026-06-24T23:30:40.616Z","updated_at":"2026-06-24T23:30:40.714Z","avatar_url":"https://github.com/graphql-markdown.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GraphQL-Markdown + MkDocs demo\n\nThis project demonstrates how to generate GraphQL documentation with GraphQL-Markdown for a MkDocs site using the Read the Docs theme.\n\n**Live demo:** [graphql-markdown.dev/demo-mkdocs](https://graphql-markdown.dev/demo-mkdocs/)\n\n## Quick start\n\n```bash\nnpm install\nnpm run dev\n```\n\nOpen `http://127.0.0.1:8000/` and use the GraphQL API entry in the navigation.\n\n## Project structure\n\n```text\n.\n├── docs/\n│   ├── graphql/                # Generated GraphQL documentation\n│   ├── index.md                # Demo home page\n│   └── stylesheets/\n│       └── gqlmd.css           # Badge styling\n├── schema.graphql              # Sample GraphQL schema\n├── scripts/\n│   ├── custom-mkdocs-mdx.mjs   # Wrapper that extends the MkDocs preset with section index links\n│   └── generate-docs.mjs       # GraphQL-Markdown runner\n├── theme-overrides/\n│   └── footer.html             # Read the Docs theme footer override\n├── mkdocs.yml                  # MkDocs configuration\n└── package.json\n```\n\n## Notes\n\n- The preset `@graphql-markdown/formatters/mkdocs` now provides:\n  - Visible page titles as `# H1` headings\n  - HTML `\u003cdetails\u003e` collapsible blocks\n  - Post-render internal link rewriting to page-relative `.md` links\n- The demo wrapper keeps one demo-specific behavior: appending generated entity links to per-section `index.md` files.\n- The Read the Docs footer attribution is overridden through `theme-overrides/footer.html`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraphql-markdown%2Fdemo-mkdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgraphql-markdown%2Fdemo-mkdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraphql-markdown%2Fdemo-mkdocs/lists"}