{"id":13625703,"url":"https://github.com/graphql-markdown/graphql-markdown","last_synced_at":"2025-05-15T05:08:38.765Z","repository":{"id":36965265,"uuid":"271746033","full_name":"graphql-markdown/graphql-markdown","owner":"graphql-markdown","description":"Flexible GraphQL Documentation Generator (Markdown)","archived":false,"fork":false,"pushed_at":"2025-05-13T20:51:01.000Z","size":30798,"stargazers_count":148,"open_issues_count":4,"forks_count":29,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-13T21:08:10.516Z","etag":null,"topics":["astrojs","documentation","documentation-generator","docusaurus","fumadocs","generator","gql","graphql","graphql-config","graphql-markdown","graphql-schema","markdown","nextjs","starlight"],"latest_commit_sha":null,"homepage":"https://graphql-markdown.dev","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/graphql-markdown.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":["https://plant.treeware.earth/graphql-markdown/graphql-markdown"]}},"created_at":"2020-06-12T08:17:12.000Z","updated_at":"2025-05-13T20:49:35.000Z","dependencies_parsed_at":"2024-01-04T17:50:55.669Z","dependency_job_id":"83215cdc-ccdb-4789-a16f-f5814fce5483","html_url":"https://github.com/graphql-markdown/graphql-markdown","commit_stats":{"total_commits":1766,"total_committers":21,"mean_commits":84.0952380952381,"dds":0.5917327293318233,"last_synced_commit":"7a28f1266b4c501f28763819095124f878351f64"},"previous_names":[],"tags_count":89,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphql-markdown%2Fgraphql-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphql-markdown%2Fgraphql-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphql-markdown%2Fgraphql-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/graphql-markdown%2Fgraphql-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/graphql-markdown","download_url":"https://codeload.github.com/graphql-markdown/graphql-markdown/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254276447,"owners_count":22043867,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["astrojs","documentation","documentation-generator","docusaurus","fumadocs","generator","gql","graphql","graphql-config","graphql-markdown","graphql-schema","markdown","nextjs","starlight"],"created_at":"2024-08-01T21:01:59.914Z","updated_at":"2025-05-15T05:08:33.729Z","avatar_url":"https://github.com/graphql-markdown.png","language":"TypeScript","readme":"[![GraphQL-Markdown](https://user-images.githubusercontent.com/324670/188957463-dae99daa-763d-466e-91f4-0629f455df74.svg)](https://graphql-markdown.dev)\n\n\u003ch1 align=\"center\"\u003eFlexible documentation for GraphQL schemas\u003c/h1\u003e\n\n[![Latest Version](https://img.shields.io/npm/v/@graphql-markdown/docusaurus?style=flat)](https://www.npmjs.com/package/@graphql-markdown/docusaurus)\n[![GitHub License](https://img.shields.io/github/license/graphql-markdown/graphql-markdown?style=flat)](https://raw.githubusercontent.com/graphql-markdown/graphql-markdown/main/LICENSE)\n[![Buy us a tree](https://img.shields.io/badge/Treeware-%F0%9F%8C%B3-lightgreen)](https://plant.treeware.earth/graphql-markdown/graphql-markdown)\n[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)\n\n\n# GraphQL-Markdown\n\nGenerate **Markdown documentation** from **GraphQL schemas** for static site generators.\n\n## Installation\n\nChoose your preferred package based on your static site generator:\n\n```shell\n# For Docusaurus\nnpm install @graphql-markdown/docusaurus graphql\n\n# For other static site generators\nnpm install @graphql-markdown/cli graphql\n```\n\n## Usage\n\n### Docusaurus Plugin\n\nAdd to your `docusaurus.config.js`:\n\n```js\nmodule.exports = {\n  plugins: [\"@graphql-markdown/docusaurus\"],\n};\n```\n\nRun the generation command:\n\n```shell\nnpx docusaurus graphql-to-doc\n```\n\n### CLI Usage\n\n```shell\nnpx gqlmd graphql-to-doc --schema ./schema.graphql --output ./docs\n```\n\n## Configuration\n\nSee [documentation configuration](https://graphql-markdown.dev/docs/configuration) page.\n\n## Troubleshooting\n\nSee [documentation troubleshooting](https://graphql-markdown.dev/docs/troubleshooting) page.\n\n## License\n\nGraphQL-Markdown packages are 100% free and open-source, under the [MIT license](https://github.com/graphql-markdown/graphql-markdown/blob/main/LICENSE).\n\nThis package is [Treeware](https://treeware.earth). If you use it in production, then we ask that you [**buy the world a tree**](https://plant.treeware.earth/graphql-markdown/graphql-markdown) to thank us for our work. By contributing to the Treeware forest you’ll be creating employment for local families and restoring wildlife habitats.\n\n## Contributions\n\n[Contributions](https://github.com/graphql-markdown/graphql-markdown/blob/main/CONTRIBUTING.md), issues and feature requests are very welcome. If you are using this package and fixed a bug for yourself, please consider submitting a PR!\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/graphql-markdown/graphql-markdown/graphs/contributors\"\u003e\n    \u003cimg src=\"https://contrib.rocks/image?repo=graphql-markdown/graphql-markdown\u0026columns=8\" /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n","funding_links":["https://plant.treeware.earth/graphql-markdown/graphql-markdown"],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraphql-markdown%2Fgraphql-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgraphql-markdown%2Fgraphql-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgraphql-markdown%2Fgraphql-markdown/lists"}