{"id":51117795,"url":"https://github.com/graphql-markdown/demo-honkit","last_synced_at":"2026-06-24T23:30:41.825Z","repository":{"id":360057445,"uuid":"1215939643","full_name":"graphql-markdown/demo-honkit","owner":"graphql-markdown","description":"GraphQL-Markdown + Honkit (Gitbook legacy) demo","archived":false,"fork":false,"pushed_at":"2026-05-24T19:06:13.000Z","size":184,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-24T21:09:59.639Z","etag":null,"topics":["document-generator","documentation","gitbook","graphql","honkit","markdown","mdx"],"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-20T12:04:16.000Z","updated_at":"2026-05-24T19:06:09.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/graphql-markdown/demo-honkit","commit_stats":null,"previous_names":["graphql-markdown/demo-honkit"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/graphql-markdown/demo-honkit","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphql-markdown%2Fdemo-honkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphql-markdown%2Fdemo-honkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphql-markdown%2Fdemo-honkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphql-markdown%2Fdemo-honkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/graphql-markdown","download_url":"https://codeload.github.com/graphql-markdown/demo-honkit/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphql-markdown%2Fdemo-honkit/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":["document-generator","documentation","gitbook","graphql","honkit","markdown","mdx"],"created_at":"2026-06-24T23:30:41.407Z","updated_at":"2026-06-24T23:30:41.820Z","avatar_url":"https://github.com/graphql-markdown.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# GraphQL-Markdown + HonKit demo\n\nThis project demonstrates how to generate GraphQL documentation with GraphQL-Markdown for a [HonKit](https://honkit.netlify.app/) site.\n\n**Live demo:** [graphql-markdown.dev/demo-honkit](https://graphql-markdown.dev/demo-honkit/)\n\n## 🚀 Project Structure\n\nInside your GraphQL-Markdown + [HonKit](https://honkit.netlify.app/) project, you'll see the following folders and files:\n\n```text\n.\n├── docs/                        # Generated output (git-ignored)\n│   ├── graphql/                 # Docs from the local schema\n│   ├── graphql-remote/          # Docs from the remote schema\n│   ├── _nav/                    # Auto-generated sidebar nav pages\n│   ├── _icons/                  # SVG icons used in the sidebar\n│   ├── README.md                # GitBook homepage\n│   └── SUMMARY.md               # GitBook/HonKit table of contents\n├── schema/\n│   └── local.graphql            # Sample local GraphQL schema\n├── scripts/\n│   └── build-summary.mjs        # Generates docs/SUMMARY.md\n├── honkit-mdx.cjs               # Custom MDX formatter for HonKit output\n├── graphql.config.mjs           # GraphQL-Markdown configuration\n└── package.json\n```\n\n## 🧞 Commands\n\nAll commands are run from the root of the project, from a terminal:\n\n| Command | Action |\n| --- | --- |\n| `npm install` | Install dependencies |\n| `npm run generate:local` | Generate docs from the local GraphQL schema |\n| `npm run generate:remote` | Generate docs from the remote GraphQL schema |\n| `npm run generate` | Generate docs from both schemas |\n| `npm run summary` | Build `docs/SUMMARY.md` (table of contents) |\n| `npm run dev` | Generate docs + serve a local HonKit preview |\n| `npm run build` | Generate docs + build a static site to `docs/_book` |\n| `npm run clean` | Remove all generated files |\n\n## 🏎️ Quick start\n\n```bash\nnpm install\nnpm run dev\n```\n\nOpen `http://localhost:4000`.\n\n\u003e 🧑‍🚀 Edit `graphql.config.mjs` to try with your own GraphQL schema.\n\n### Override the remote schema endpoint\n\nBy default the remote project points to `https://countries.trevorblades.com/graphql`.\nCopy the example env file, then edit the values:\n\n```bash\ncp .env.example .env\n```\n\n```bash\nGRAPHQL_ENDPOINT=\"https://your-api/graphql\" npm run generate:remote\n```\n\n## 🗂️ GitBook.com import workflow\n\n1. Run `npm run generate` (or one of the per-schema commands).\n2. In GitBook.com, create or open a space.\n3. Import files from the `docs/` folder:\n   - include `docs/README.md`\n   - include `docs/graphql/` and/or `docs/graphql-remote/`\n4. Publish or preview the imported pages.\n\n\u003e The formatter in `honkit-mdx.cjs` keeps output Markdown-compatible for HonKit and GitBook.com imports.\n\n## 👀 Want to learn more?\n\nCheck out [GraphQL-Markdown's docs](https://graphql-markdown.dev/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraphql-markdown%2Fdemo-honkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgraphql-markdown%2Fdemo-honkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraphql-markdown%2Fdemo-honkit/lists"}