{"id":32376220,"url":"https://github.com/xisenao/docs-islands","last_synced_at":"2026-05-14T13:37:07.699Z","repository":{"id":319253425,"uuid":"1065756158","full_name":"XiSenao/docs-islands","owner":"XiSenao","description":"Cross-framework Islands Architecture for documentation sites","archived":false,"fork":false,"pushed_at":"2025-10-17T08:42:41.000Z","size":9690,"stargazers_count":0,"open_issues_count":1,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-18T11:39:38.675Z","etag":null,"topics":["cross-framework","frontend","hydration","islands-architecture","react","ssr","vitepress"],"latest_commit_sha":null,"homepage":"http://docs.senao.me/docs-islands","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/XiSenao.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","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":"2025-09-28T11:15:00.000Z","updated_at":"2025-10-17T08:42:44.000Z","dependencies_parsed_at":null,"dependency_job_id":"11c941f5-23f2-49e8-9e4a-2daf38a6eb89","html_url":"https://github.com/XiSenao/docs-islands","commit_stats":null,"previous_names":["xisenao/docs-islands"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/XiSenao/docs-islands","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XiSenao%2Fdocs-islands","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XiSenao%2Fdocs-islands/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XiSenao%2Fdocs-islands/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XiSenao%2Fdocs-islands/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/XiSenao","download_url":"https://codeload.github.com/XiSenao/docs-islands/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/XiSenao%2Fdocs-islands/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280878244,"owners_count":26406643,"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-10-24T02:00:06.418Z","response_time":73,"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":["cross-framework","frontend","hydration","islands-architecture","react","ssr","vitepress"],"created_at":"2025-10-24T22:53:23.484Z","updated_at":"2026-05-14T13:37:07.668Z","avatar_url":"https://github.com/XiSenao.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docs Islands\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://docs.senao.me/docs-islands\" target=\"_blank\" rel=\"noopener noreferrer\"\u003e\n    \u003cimg width=\"180\" src=\"https://docs.senao.me/docs-islands/favicon.svg\" alt=\"Docs Islands logo\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\u003cbr/\u003e\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://nodejs.org/en/about/previous-releases\"\u003e\u003cimg src=\"https://img.shields.io/node/v/@docs-islands/vitepress.svg\" alt=\"node compatibility\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/XiSenao/docs-islands/actions/workflows/ci.yml\"\u003e\u003cimg src=\"https://github.com/XiSenao/docs-islands/actions/workflows/ci.yml/badge.svg?branch=main\" alt=\"build status\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://pr.new/XiSenao/docs-islands/tree/stackblitz?file=docs/en/index.md\"\u003e\u003cimg src=\"https://developer.stackblitz.com/img/start_pr_dark_small.svg\" alt=\"Start new PR in StackBlitz Codeflow\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\u003cbr/\u003e\n\nEnglish | [简体中文](./README.zh-CN.md)\n\n\u003e **⚡ Project Status**: Actively developed - VitePress integration production ready.\n\nBrings the performance benefits of Islands Architecture to documentation frameworks. Static content loads instantly while interactive components activate on-demand, enabling documentation sites to achieve both the speed of static websites and the interactivity of modern applications. Supports cross-framework UI usage, currently providing production-grade integration for VitePress.\n\n## Key Features\n\n- **🏝️ Exceptional Performance** - Static content renders instantly while interactive components load on-demand. Documentation sites achieve both the speed of static websites and the interactivity of modern applications, delivering a seamless reading experience.\n\n- **🎯 Flexible Rendering Strategies** - Fine-grained control over each component's rendering and hydration timing. Supports server-side rendering (`ssr:only`), eager loading (`client:load`), viewport-triggered loading (`client:visible`), and client-only rendering (`client:only`). Eliminates unnecessary JavaScript execution, ensuring interactions happen at precisely the right moment.\n\n- **🧩 Extensible Architecture** - Design philosophy supports extension to other mainstream documentation frameworks. Currently provides production-grade integration for VitePress, with gradual platform coverage as the community evolves, maintaining flexibility in technology choices.\n\n- **⚛️ Cross-Framework Support** - Freely use React, Vue, Solid, Svelte, or any preferred UI framework within documentation. Teams can leverage existing component libraries and development expertise without learning new technology stacks.\n\n- **🔌 Rapid Integration** - Enable Islands capabilities in existing documentation projects with minimal configuration. No code refactoring required, no disruption to existing functionality—progressively enhance interactivity.\n\n- **📦 Polished Developer Experience** - Instant feedback through hot module replacement in development, consistent behavior across dev and production environments. Complete TypeScript support and performance optimization options ensure a smooth experience from development to deployment.\n\n\u003e For more details and usage guides, visit the [documentation site](https://docs.senao.me/docs-islands/).\n\n## Packages\n\n| Package                                       | Version (click for changelogs)                                                                                              |\n| --------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------- |\n| [@docs-islands/vitepress](packages/vitepress) | [![vitepress version](https://img.shields.io/npm/v/@docs-islands/vitepress.svg?label=%20)](packages/vitepress/CHANGELOG.md) |\n| [@docs-islands/logger](packages/logger)       | [![vitepress version](https://img.shields.io/npm/v/@docs-islands/logger.svg?label=%20)](packages/logger/CHANGELOG.md)       |\n\n## Contributing\n\nCommunity contributions are welcome! Please see the [Contributing Guide](https://github.com/XiSenao/docs-islands/blob/main/.github/CONTRIBUTING.md) for details.\n\n## License\n\nMIT © [XiSenao](https://github.com/XiSenao)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxisenao%2Fdocs-islands","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxisenao%2Fdocs-islands","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxisenao%2Fdocs-islands/lists"}