Repolode
Submit
livesession

livesession/xyd

A TypeScript docs framework that builds documentation sites from Markdown/MDX, with OpenAPI and GraphQL API doc generation.

Open-source alternative to:Readme.comGitBook

View on GitHubWebsite
Stars
115
Forks
9
Open issues
36
Last commit
9 days ago

What is it?

xyd is a documentation framework built with TypeScript and React. It turns Markdown and MDX content into a documentation website, and includes a development server with hot reload that works without configuration, plus a command to build static files for deployment.

Its distinguishing feature is native support for API specifications. It generates documentation from OpenAPI and GraphQL schemas and offers SDK generation from those specs. Built-in themes, full-text search, and integrations for analytics, A/B testing, and live chat are also included, and components can be extended or replaced.

The project is MIT-licensed and requires Node 22.12 or later. It ships with a migration tool for moving from other docs frameworks.

Key features

  • 01Generates docs from Markdown and MDX content
  • 02Builds API reference pages from OpenAPI and GraphQL specs
  • 03Offers SDK generation from API specifications
  • 04Includes built-in themes and full-text search
  • 05Provides integrations for analytics, A/B testing, and live chat
  • 06Components and layouts can be customized

Use cases

  • Publishing product documentation for a web application
  • Documenting a REST or GraphQL API with generated reference pages
  • Building a developer portal that ships SDKs alongside API docs
  • Migrating an existing docs site from another framework

Quick start

  1. 1

    Confirm Node 22.12+ is installed

  2. 2

    Install xyd globally with bun

    bun add -g xyd-js
  3. 3

    Run a dev server

    xyd
  4. 4

    Build the static docs files

    xyd build

Things to know

  • Requires Node 22.12 or newer.

In collections

GraphQL APIs & API clientsStatic site generators & documentation tools

Topics

#docs#documentation#markdown#mdx#openapi#graphql#api-docs#react#api-explorer#docs-generator

FAQ

What is xyd?
A TypeScript docs framework that builds documentation sites from Markdown/MDX, with OpenAPI and GraphQL API doc generation. xyd is a documentation framework built with TypeScript and React. It turns Markdown and MDX content into a documentation website, and includes a development server with hot reload that works without configuration, plus a command to build static files for deployment.
Is xyd free to use? What license does it have?
xyd is open source under the MIT license. Check the license terms before using it in commercial products.
Is xyd still maintained?
Actively maintained. The last commit to xyd was on Oct 29, 2026.
What can I use xyd for?
Publishing product documentation for a web application Documenting a REST or GraphQL API with generated reference pages Building a developer portal that ships SDKs alongside API docs Migrating an existing docs site from another framework
How do I install xyd?
Confirm Node 22.12+ is installed Install xyd globally with bun: bun add -g xyd-js Run a dev server: xyd Build the static docs files: xyd build
Where can I get xyd?
The source code and installation instructions are on GitHub: https://github.com/livesession/xyd

Summary generated by AI from the project's README. GitHub stats refresh daily.

Related projects