{"id":51117793,"url":"https://github.com/graphql-markdown/demo-docfx","last_synced_at":"2026-06-24T23:30:41.365Z","repository":{"id":361654064,"uuid":"1219305823","full_name":"graphql-markdown/demo-docfx","owner":"graphql-markdown","description":"GraphQL-Markdown + DocFX demo","archived":false,"fork":false,"pushed_at":"2026-05-31T17:45:10.000Z","size":11,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-31T18:18:43.756Z","etag":null,"topics":["demo","docfx","documentation","documentation-generator","graphql","markdown"],"latest_commit_sha":null,"homepage":"https://graphql-markdown.dev/","language":"JavaScript","has_issues":false,"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:36:01.000Z","updated_at":"2026-05-31T17:44:39.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/graphql-markdown/demo-docfx","commit_stats":null,"previous_names":["graphql-markdown/demo-docfx"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/graphql-markdown/demo-docfx","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphql-markdown%2Fdemo-docfx","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphql-markdown%2Fdemo-docfx/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphql-markdown%2Fdemo-docfx/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphql-markdown%2Fdemo-docfx/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/graphql-markdown","download_url":"https://codeload.github.com/graphql-markdown/demo-docfx/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphql-markdown%2Fdemo-docfx/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":["demo","docfx","documentation","documentation-generator","graphql","markdown"],"created_at":"2026-06-24T23:30:40.714Z","updated_at":"2026-06-24T23:30:41.359Z","avatar_url":"https://github.com/graphql-markdown.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GraphQL-Markdown + DocFX demo\n\nThis project demonstrates how to generate GraphQL documentation with GraphQL-Markdown for a [DocFX](https://dotnet.github.io/docfx/) site using the modern template.\n\n**Live demo:** [graphql-markdown.dev/demo-docfx](https://graphql-markdown.dev/demo-docfx/)\n\n## Quick start\n\n```bash\nnpm install\nnpm run dev\n```\n\nOpen `http://localhost:8080/` and browse the **GraphQL API** section in the left navigation.\n\n## Prerequisites\n\n- [Node.js](https://nodejs.org) 20 or later\n- [.NET SDK](https://dotnet.microsoft.com/download) 8 or later\n- DocFX installed as a global .NET tool:\n\n```bash\ndotnet tool install -g docfx\n```\n\n## Commands\n\n| Command | Action |\n| --- | --- |\n| `npm install` | Install dependencies |\n| `npm run generate` | Generate docs from the GraphQL schema |\n| `npm run dev` | Generate docs + serve a local DocFX preview |\n| `npm run build` | Generate docs + build a static site to `_site/` |\n| `npm run clean` | Remove generated files and build output |\n\n## Project structure\n\n```text\n.\n├── content/\n│   └── index.md                    # Homepage source for the GraphQL API section\n├── docs/\n│   ├── graphql/                    # Generated GraphQL documentation\n│   │   ├── index.md                # GraphQL API overview (copied from content/index.md)\n│   │   ├── toc.yml                 # Generated navigation\n│   │   ├── operations/             # Queries, mutations, subscriptions\n│   │   └── types/                  # Objects, scalars, directives\n│   ├── introduction.md\n│   ├── getting-started.md\n│   └── toc.yml\n├── schema.graphql                  # Sample GraphQL schema\n├── scripts/\n│   ├── custom-docfx-mdx.mjs        # Custom MDX formatter (badge color overrides)\n│   └── generate-docs.mjs           # GraphQL-Markdown runner\n├── docfx.json                      # DocFX site configuration\n├── index.md                        # Site root (redirects to introduction)\n├── toc.yml                         # Top-level navigation\n└── package.json\n```\n\n## Notes\n\n- The preset `@graphql-markdown/formatters/docfx` provides:\n  - DocFX alert syntax (`\u003e [!NOTE]`, `\u003e [!WARNING]`, etc.) for admonitions\n  - Bootstrap 5 badge classes (`badge text-bg-{variant}`) for type badges\n  - Path-derived `uid` front matter for unique DocFX cross-reference targets (e.g. `operations-queries-continent`)\n  - `afterRenderTypeEntitiesHook` that builds `toc.yml` navigation files at every directory level automatically\n- Badge colors can be customized in `scripts/custom-docfx-mdx.mjs` by spreading `BADGE_CLASS_MAP` and overriding individual entries.\n- `toc.yml` files in `docs/graphql/` are generated at doc-generation time and should not be edited manually.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraphql-markdown%2Fdemo-docfx","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgraphql-markdown%2Fdemo-docfx","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraphql-markdown%2Fdemo-docfx/lists"}