Loading...
Discovering amazing open source projects
Discovering amazing open source projects
Loading post content...
xyd delivers a fully open, plug‑and‑play documentation platform that lets you generate API docs, embed analytics, and customize every UI component—without vendor lock‑in or hidden costs.
Writing clear, searchable, and interactive documentation used to be a series of compromises: you’d pick a static site generator for speed, add a third‑party analytics service for insights, then wrestle with a separate tool to turn OpenAPI specs into readable pages. The result? Fragmented workflows, hidden costs, and a constant fear that your docs will become a vendor‑locked afterthought.
xyd flips that script. It’s a single, open‑source framework that bundles a dev‑friendly CLI, theme system, API‑first documentation generation, built‑in analytics, A/B testing, and live‑chat integrations—all under a permissive license you can host anywhere. In short, it gives you the power of a commercial docs platform without the subscription fees or data‑privacy worries.
xyd
), TypeScript support, and a CLI that feels like create‑react‑app
for docs.Feature | What xyd Delivers |
---|---|
Themes | Six built‑in themes (Solar, Gusto, Poetry, Picasso, Opener, Cosmo) plus a theming API for custom designs. |
Plug & Play Dev Server | xyd starts a local server instantly with hot‑module replacement—no config files needed. |
API Docs Generation | Point to an OpenAPI or GraphQL schema and xyd renders clean, searchable reference pages automatically. |
Plugin Ecosystem | Official plugins for search (Orama, Algolia), analytics (LiveSession), chat (Intercom, Chatwoot, LiveChat), and A/B testing (LaunchDarkly, GrowthBook). |
Built‑in Analytics | Capture page views, custom events, and session replays without adding external scripts. |
A/B Testing | Toggle content experiments directly from the docs UI, powered by LaunchDarkly or GrowthBook. |
Full‑text Search | Typo‑tolerant, relevance‑scored search powered by Orama or Algolia, with instant results. |
Live Chat Integration | Embed Intercom, LiveChat, or Chatwoot widgets with a single config line. |
Developer Content | Advanced syntax highlighting, interactive code playgrounds, and tooling for SDK generation (TypeScript, Python, Go, etc.). |
Extensible Architecture | Replace any component, add custom scripts, or inject global providers via a simple plugin API. |
The quickest way to spin up a documentation site is with Bun, but npm/yarn works just as well.
# Install the CLI globally (Bun)
bun add -g xyd-js
# Or with npm
npm i -g xyd-js
Create a new project from the starter template:
# Using the official starter
xyd init my-docs
cd my-docs
Run the dev server:
xyd
Open http://localhost:3000
and you’ll see a hot‑reloading docs site ready for customization. When you’re ready to publish:
xyd build
# Output goes to ./dist – serve it with any static host or your own CDN
Place an openapi.yaml
(or schema.graphql
) in the src/api
folder and add a single entry to xyd.config.ts
:
export default {
api: {
openapi: "./src/api/openapi.yaml",
// optional: generate SDKs automatically
sdk: { languages: ["typescript", "python"] },
},
};
Run xyd build
again and the framework will generate a fully searchable API reference, complete with code samples for each endpoint.
Feature | xyd (Open source) | Mintlify (SaaS) | GitBook | Read the Docs | Docusaurus |
---|---|---|---|---|---|
License | MIT (self‑hosted) | Proprietary SaaS | Proprietary SaaS (free tier) | BSD‑3 (self‑hosted) | MIT (self‑hosted) |
Cost | Free + hosting | Starts at $20/mo | Free tier, paid plans from $8/mo | Free (hosted) or self‑hosted (free) | Free (hosting costs separate) |
Self‑hosting | ✅ | ❌ | ✅ (via API) | ✅ | ✅ |
OpenAPI/GraphQL docs | ✅ automatic generation | ✅ (paid) | ❌ | ❌ | ✅ (via plugins) |
Built‑in analytics | ✅ (LiveSession integration) | ✅ (Mintlify Insights) | ❌ (needs third‑party) | ❌ | ❌ |
A/B testing | ✅ (LaunchDarkly, GrowthBook) | ✅ (Mintlify Experiments) | ❌ | ❌ | ❌ |
Live‑chat integration | ✅ (Intercom, Chatwoot, LiveChat) | ❌ | ❌ | ❌ | ❌ |
Full‑text search | ✅ (Orama, Algolia) | ✅ (Mintlify Search) | ✅ (Algolia) | ✅ (Algolia) | ✅ (Algolia) |
Theme customization | ✅ (6 built‑in + custom) | ✅ (limited) | ✅ (limited) | ✅ (basic) | ✅ (highly customizable) |
Extensibility via plugins | ✅ rich ecosystem | ❌ | ✅ | ✅ | ✅ |
Data privacy | Full control (self‑hosted) | Data stored on Mintlify servers | Data stored on Mintlify servers | Data stored on Read the Docs servers | Full control (self‑hosted) |
Vendor lock‑in | ❌ none | ✅ high | ✅ moderate | ✅ moderate | ❌ none |
The table highlights why teams that prioritize privacy, extensibility, and cost‑effectiveness often gravitate toward an open‑source solution like xyd.
For weekly news in the tech-world check out The Infinity Dev Newsletter
If you’re ready to ditch the fragmented stack and give your developers a single, powerful platform for documentation, API reference, analytics, and experimentation, give xyd a spin today.
Join the community on GitHub and Slack, contribute a plugin, or simply start building your next docs site with zero‑cost, zero‑vendor lock‑in. The future of developer documentation is open—make it yours with xyd.
Curating the best open source projects every day. Follow us for daily discoveries of amazing tools and libraries.
Get all the latest posts delivered straight to your inbox.
We respect your privacy. Unsubscribe at any time.