Docs Framework for future dev.

---

Quickstart

Important

Node 22.12+ is required

# install
bun add -g xyd-js

# run a dev server
xyd 

# build a docs static files
xyd build

Our Philosophy

1. Developer Experience - designed to be easy to use, with a focus on developer experience

2. Extendability - customize every part of documentation

3. Rich Content - create engaging documentation with interactive components and dynamic content capabilities

4. Batteries Included - everything to build docs at scale is here

5. Open - we believe that docs frameworks should be fully open source

Major Features

• 🎨 Themes - Built-in themes: Solar, Gusto, Poetry, Picasso, Opener, and Cosmo
• 🚀 Plug & Play Dev Server - Instant development server with hot reload and zero configuration
• ⚙️ Easy customization - Extend and modify every component, layout, and functionality
• 🔗 OpenAPI / GraphQL API docs generation - Automatic documentation generation from API specifications
• 🔌 Plugins - Rich ecosystem of plugins for search, analytics, chat, and more
• 📊 Analytics - Built-in analytics integration with support for custom events and session replay with LiveSession
• 🧪 A/B testing - Built-in integration for A/B testing experiments with LaunchDarkly and GrowthBook
• 🔍 Full-text search - Lightning-fast search with typo tolerance and relevance scoring
• 💬 Live chat - Seamless integration with Intercom, LiveChat, and Chatwoot
• 💻 Developer content - Advanced syntax highlighting with interactive code examples and tooling for developers
• 🔧 SDK generation capabilities - Automatic SDK generation from API specifications

Documentation

For more info head over to our docs.

Resources

Starter

🚀 The starter for xyd docs

Examples

📚 Ready-to-run xyd examples

Deploy Samples

📦 Ready-to-run xyd deploy samples

API Docs Demo

🔗 Live demo showcasing xyd's API documentation capabilities.

Storybook

👩‍🎤 Collection of built-in components.

FAQ

How is this different than other Docs Framework?

• 100% open source
• Batteries included - native support for API specs (GraphQL/OpenAPI), SDK generation, Code Languages API docs and more++
• Design System - we built components with design system philosophy
• Not only docs - xyd is using a couple of in-house packages you can use standalone, e.g a docs writing engine or a set of tools for modern API docs

Why another yet docs framework?

At LiveSession we're on our way to creating a next-generation analytics platform. We need a powerful tool that will meet our needs. You can read the story behind it here.

How to migrate from my current docs framework to xyd?

First of all, great to hear that! We have a migration tool for a bunch of docs frameworks.

Contributing

Development

Development guide with setup instructions, available scripts, and contribution guidelines.

---

---

Join our community