{"id":26448784,"url":"https://github.com/kavinraja-g/crossplane-docs","last_synced_at":"2026-01-12T13:25:43.937Z","repository":{"id":230577500,"uuid":"776451408","full_name":"Kavinraja-G/crossplane-docs","owner":"Kavinraja-G","description":"Docs (XDOCs) generator for Crossplane","archived":false,"fork":false,"pushed_at":"2026-01-10T05:32:21.000Z","size":97,"stargazers_count":6,"open_issues_count":2,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-01-11T01:36:02.682Z","etag":null,"topics":["cncf","crossplane","documentation","generator","golang","kubernetes"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Kavinraja-G.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2024-03-23T14:48:39.000Z","updated_at":"2026-01-10T05:32:24.000Z","dependencies_parsed_at":"2024-03-30T15:47:03.466Z","dependency_job_id":"b642d69c-fa65-42ef-9791-b749ab80846e","html_url":"https://github.com/Kavinraja-G/crossplane-docs","commit_stats":null,"previous_names":["kavinraja-g/crossplane-docs"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/Kavinraja-G/crossplane-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kavinraja-G%2Fcrossplane-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kavinraja-G%2Fcrossplane-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kavinraja-G%2Fcrossplane-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kavinraja-G%2Fcrossplane-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Kavinraja-G","download_url":"https://codeload.github.com/Kavinraja-G/crossplane-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Kavinraja-G%2Fcrossplane-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28339003,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T12:22:26.515Z","status":"ssl_error","status_checked_at":"2026-01-12T12:22:10.856Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["cncf","crossplane","documentation","generator","golang","kubernetes"],"created_at":"2025-03-18T14:42:25.565Z","updated_at":"2026-01-12T13:25:43.887Z","avatar_url":"https://github.com/Kavinraja-G.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# crossplane-docs\n## What is XDocs?\n- We have XR, XRD, XRC ;) Why not XDocs?\n- Inspired from [terraform-docs](https://github.com/terraform-docs/terraform-docs) but for [Crossplane](https://www.crossplane.io/)\n- Generate markdown based docs for your Compositions, it also includes your linked Resources, XRD and Claim\n\n## Installation\n**XDocs** Generator can be installed in several ways to suit your preferences and development environments\n\n### Homebrew Tap (macOS \u0026 Linux)\n\nIf you're using Homebrew, you can install the tool via our custom Homebrew tap\n\n```bash\nbrew tap Kavinraja-G/tap\nbrew install crossplane-docs\n```\n\n### Standalone Binary\nFor macOS, Linux, and Windows, standalone binaries are available. Download the appropriate binary for your operating system from the [releases](https://github.com/Kavinraja-G/crossplane-docs/releases/) page, then move it to a directory in your PATH.\n\n#### macOS/Linux\n```bash\n# Feel free to change the release/arch names accordingly\ncurl -Lo crossplane-docs https://github.com/Kavinraja-G/crossplane-docs/releases/download/v0.1.0/crossplane-docs_v0.1.0_darwin_amd64.tar.gz\nchmod +x crossplane-docs\nsudo mv crossplane-docs /usr/local/bin/\n```\n\n#### Windows\nDownload the `.exe` file and add it to your `PATH`\n\n### Docker\nAnother easiest way to use crossplane-docs is via Docker. Can be really useful if it's integrated in CI/CD pipelines.\n\n```bash\n# Generate docs for your compositions\ndocker run --rm -v $(pwd):/workspace ghcr.io/kavinraja-g/crossplane-docs:latest md /workspace/samples -o /workspace/samples/README.md\n\n# Generate XRD-only docs\ndocker run --rm -v $(pwd):/workspace ghcr.io/kavinraja-g/crossplane-docs:latest md /workspace/samples -o /workspace/samples/README.md --xrd-only\n```\n\n## Getting Started\nCurrently xDocs supports only markdown output, but more in pipeline. To generate markdown docs for your compositions \u0026 XRDs\n```bash\n# Generate markdown docs for given compositions and XRDs\ncrossplane-docs md [INPUT_PATH] -o [OUTPUT_FILE]\n\n# In some cases users prefer to generate XRD docs since pipeline mode is not supported\ncrossplane-docs md [INPUT_PATH] -o [OUTPUT_FILE] --xrd-only\n```\n\nFor example:\n```bash\ncrossplane-docs md ./samples -o samples/README.md\n```\n\nCheck [README.md](./samples/README.md) for the output.\n\n## Features\n- Discovers Composition \u0026 its resources, XR, XRD and Claim names with their references\n- Markdown ouput with tabulation\n- Supports generating only XRD docs\n- Claim/XRC specifications\n\n## Limitations\nCrossplane compositions with Pipeline composition mode is not supported.\n\n## License\nDistributed under the Apache-2.0 License. See [LICENSE](./LICENSE) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkavinraja-g%2Fcrossplane-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkavinraja-g%2Fcrossplane-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkavinraja-g%2Fcrossplane-docs/lists"}