https://github.com/xisenao/docs-islands
Cross-framework Islands Architecture for documentation sites
https://github.com/xisenao/docs-islands
cross-framework frontend hydration islands-architecture react ssr vitepress
Last synced: 20 days ago
JSON representation
Cross-framework Islands Architecture for documentation sites
- Host: GitHub
- URL: https://github.com/xisenao/docs-islands
- Owner: XiSenao
- License: mit
- Created: 2025-09-28T11:15:00.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-10-17T08:42:41.000Z (8 months ago)
- Last Synced: 2025-10-18T11:39:38.675Z (8 months ago)
- Topics: cross-framework, frontend, hydration, islands-architecture, react, ssr, vitepress
- Language: TypeScript
- Homepage: http://docs.senao.me/docs-islands
- Size: 9.24 MB
- Stars: 0
- Watchers: 0
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Docs Islands
English | [简体中文](./README.zh-CN.md)
> **⚡ Project Status**: Actively developed - VitePress integration production ready.
Brings 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.
## Key Features
- **🏝️ 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.
- **🎯 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.
- **🧩 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.
- **⚛️ 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.
- **🔌 Rapid Integration** - Enable Islands capabilities in existing documentation projects with minimal configuration. No code refactoring required, no disruption to existing functionality—progressively enhance interactivity.
- **📦 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.
> For more details and usage guides, visit the [documentation site](https://docs.senao.me/docs-islands/).
## Packages
| Package | Version (click for changelogs) |
| --------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------- |
| [@docs-islands/vitepress](packages/vitepress) | [](packages/vitepress/CHANGELOG.md) |
| [@docs-islands/logger](packages/logger) | [](packages/logger/CHANGELOG.md) |
## Contributing
Community contributions are welcome! Please see the [Contributing Guide](https://github.com/XiSenao/docs-islands/blob/main/.github/CONTRIBUTING.md) for details.
## License
MIT © [XiSenao](https://github.com/XiSenao)