{"id":22791932,"url":"https://github.com/livesession/xyd","last_synced_at":"2025-09-11T16:13:21.128Z","repository":{"id":265969624,"uuid":"896939708","full_name":"livesession/xyd","owner":"livesession","description":"ambitious docs framework for everyone","archived":false,"fork":false,"pushed_at":"2025-09-10T14:12:47.000Z","size":63776,"stargazers_count":64,"open_issues_count":32,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-10T15:57:42.526Z","etag":null,"topics":["api-explorer","docs","docs-generator","documentation","graphql","markdown","mdx","openapi","react","rest-api"],"latest_commit_sha":null,"homepage":"https://xyd.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/livesession.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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-12-01T17:16:10.000Z","updated_at":"2025-09-10T14:12:49.000Z","dependencies_parsed_at":"2024-12-01T21:25:15.136Z","dependency_job_id":"e09ece39-cde7-4fa7-b67a-8ef46aad37a3","html_url":"https://github.com/livesession/xyd","commit_stats":null,"previous_names":["livesession/xyd"],"tags_count":25,"template":false,"template_full_name":null,"purl":"pkg:github/livesession/xyd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livesession%2Fxyd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livesession%2Fxyd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livesession%2Fxyd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livesession%2Fxyd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/livesession","download_url":"https://codeload.github.com/livesession/xyd/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/livesession%2Fxyd/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274666020,"owners_count":25327355,"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","status":"online","status_checked_at":"2025-09-11T02:00:13.660Z","response_time":74,"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":["api-explorer","docs","docs-generator","documentation","graphql","markdown","mdx","openapi","react","rest-api"],"created_at":"2024-12-12T03:08:24.092Z","updated_at":"2025-09-11T16:13:21.120Z","avatar_url":"https://github.com/livesession.png","language":"TypeScript","readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://xyd.dev\"\u003e\n    \u003cpicture\u003e\n      \u003csource srcset=\".github/assets/readme-logo-dark.svg\" media=\"(prefers-color-scheme: dark)\"\u003e\n      \u003csource srcset=\".github/assets/readme-logo.svg\" media=\"(prefers-color-scheme: light)\"\u003e\n      \u003cimg src=\".github/assets/readme-logo.svg\" alt=\"xyd logo\"\u003e\n    \u003c/picture\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003eDocs Framework for future dev.\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/xyd-js\"\u003e\u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/v/xyd-js?style=flat-square\u0026color=70e000\" /\u003e\u003c/a\u003e\n  \u003ca href=\"https://xyd-docs.slack.com\" target=\"_blank\" rel=\"noopener\"\u003e\n   \u003cimg alt=\"Slack Community\" src=\"https://img.shields.io/badge/Slack-Community-4A154B?logo=slack\u0026logoColor=white\"\u003e\n  \u003c/a\u003e\n   \u003ca href=\"https://github.com/livesession/xyd/discussions\"\u003e\n  \u003cimg\n    alt=\"GitHub Discussions\"\n    src=\"https://img.shields.io/badge/-Github%20Discussions-181717?logo=github\u0026logoColor=white\"\n  /\u003e\n\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://app.netlify.com/start/deploy?repository=https://github.com/xyd-js/deploy-samples\u0026base=netlify\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n    \u003cimg src=\"https://www.netlify.com/img/deploy/button.svg\" alt=\"Deploy to Netlify\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fxyd-js%2Fdeploy-samples%2Ftree%2Fmaster%2Fvercel\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n    \u003cimg src=\"https://vercel.com/button\" alt=\"Deploy with Vercel\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://codesandbox.io/p/github/xyd-js/deploy-samples-codesandbox\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n    \u003cimg src=\"https://codesandbox.io/static/img/play-codesandbox.svg\" alt=\"Open in CodeSandbox\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n[![xyd README hero](.github/assets/readme-hero.png)](https://www.youtube.com/watch?v=8FVINsWUgUs)\n\n---\n\n## Quickstart\n\u003e [!IMPORTANT]\n\u003e Node 22.12+ is required\n\n```bash\n# install\nbun add -g xyd-js\n\n# run a dev server\nxyd \n\n# build a docs static files\nxyd build\n```\n\n## Our Philosophy\n1. Developer Experience - designed to be easy to use, with a focus on developer experience\n\n2. Extendability - customize every part of documentation\n\n3. Rich Content - create engaging documentation with interactive components and dynamic content capabilities\n\n4. Batteries Included - everything to build docs at scale is here\n\n5. Open - we believe that docs frameworks should be fully open source\n\n## Major Features\n- 🎨 **Themes** - Built-in [themes](https://github.com/xyd-js/themes): [Solar](https://solar.xyd.dev), [Gusto](https://gusto.xyd.dev), [Poetry](https://poetry.xyd.dev), [Picasso](https://picasso.xyd.dev), [Opener](https://opener.xyd.dev), and [Cosmo](https://cosmo.xyd.dev)\n- 🚀 **Plug \u0026 Play Dev Server** - Instant development server with hot reload and zero configuration\n- ⚙️ **Easy customization** - Extend and modify every component, layout, and functionality\n- 🔗 **OpenAPI / GraphQL API docs generation** - Automatic documentation generation from API specifications\n- 🔌 **Plugins** - Rich ecosystem of plugins for search, analytics, chat, and more\n- 📊 **Analytics** - Built-in analytics integration with support for custom events and session replay with LiveSession\n- 🧪 **A/B testing** - Built-in integration for A/B testing experiments with LaunchDarkly and GrowthBook\n- 🔍 **Full-text search** - Lightning-fast search with typo tolerance and relevance scoring\n- 💬 **Live chat** - Seamless integration with Intercom, LiveChat, and Chatwoot\n- 💻 **Developer content** - Advanced syntax highlighting with interactive code examples and tooling for developers\n- 🔧 **SDK generation capabilities** - Automatic SDK generation from API specifications\n\n## Documentation\nFor more info [**head over to our docs**](https://xyd.dev/docs).\n\n## Resources\n### [Starter](https://github.com/xyd-js/starter)\n🚀 The starter for xyd docs\n\n### [Examples](https://github.com/xyd-js/examples)\n📚 Ready-to-run xyd examples\n\n### [Deploy Samples](https://github.com/xyd-js/deploy-samples)\n📦 Ready-to-run xyd deploy samples\n\n### [API Docs Demo](https://apidocs-demo.xyd.dev/)\n🔗 Live demo showcasing xyd's API documentation capabilities.\n\n### [Storybook](https://components.xyd.dev)\n👩‍🎤 Collection of built-in components.\n\n## FAQ\n\n### How is this different than other Docs Framework?\n\n- 100% open source\n- Batteries included - native support for API specs (GraphQL/OpenAPI), SDK generation, Code Languages API docs and more++\n- Design System - we built components with [design system](https://components.xyd.dev) philosophy\n- Not only docs - xyd is using a couple of in-house packages you can use standalone, e.g a [docs writing engine](https://xwrite.dev) or a set of [tools for modern API docs](https://apitoolchain.dev)\n\n### Why another yet docs framework?\nAt [LiveSession](https://livesession.io/) we're on our way to creating a next-generation analytics platform.\nWe need a powerful tool that will meet our needs.\nYou can [read the story behind it here](https://blog.livesession.dev/why-another-yet-docs-framework).\n\n### How to migrate from my current docs framework to xyd?\nFirst of all, great to hear that! We have a [migration tool](https://xyd.dev/docs/resources/migration-tool) for a bunch of docs frameworks.\n\n## Contributing\n### [Development](./DEVELOPMENT.md)\nDevelopment guide with setup instructions, available scripts, and contribution guidelines.\n\n---\n\n\u003cimg src=\"https://api.basely.dev/github/download/releases/livesession/xyd?asset=node-support-baseline.png\"/\u003e\n\n---\n\n\u003cdiv style=\"display: flex;\"\u003e\n \u003cp\u003e\n   \u003cb\u003eJoin our community\u003c/b\u003e\u0026nbsp;\n \u003c/p\u003e\n \u003ca href=\"https://xyd-docs.slack.com\" target=\"_blank\" rel=\"noopener\"\u003e\n  \u003cimg alt=\"Slack Community\" src=\"https://img.shields.io/badge/Slack-Community-4A154B?logo=slack\u0026logoColor=white\"\u003e\n \u003c/a\u003e\n  \u0026nbsp;\n \u003ca href=\"https://github.com/livesession/xyd/discussions\"\u003e\n  \u003cimg\n    alt=\"GitHub Discussions\"\n    src=\"https://img.shields.io/badge/-Github%20Discussions-181717?logo=github\u0026logoColor=white\"\n  /\u003e\n\u003c/a\u003e\n\u003c/div\u003e\n","funding_links":[],"categories":["General Tools"],"sub_categories":["Site Builder"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flivesession%2Fxyd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flivesession%2Fxyd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flivesession%2Fxyd/lists"}