Repolode
Предложить
livesession

livesession/xyd

Фреймворк для документации на TypeScript: собирает сайты из Markdown/MDX и генерирует документацию API по спецификациям OpenAPI и GraphQL.

Open source альтернатива:Readme.comGitBook

Открыть на GitHubСайт
Звёзды
115
Форки
9
Открытые issues
36
Последний коммит
9 дней назад

Что это?

xyd — фреймворк для документации на TypeScript и React. Он превращает контент в Markdown и MDX в сайт документации. В комплекте есть сервер разработки с горячей перезагрузкой, который работает без настройки, а также команда для сборки статических файлов и их развёртывания.

Главная особенность проекта — встроенная поддержка спецификаций API. Он генерирует документацию по схемам OpenAPI и GraphQL и позволяет создавать SDK на основе этих спецификаций. Также в комплект входят готовые темы, полнотекстовый поиск и интеграции с аналитикой, A/B-тестированием и онлайн-чатом. Компоненты можно расширять и заменять.

Проект распространяется по лицензии MIT и требует Node версии 22.12 или новее. В комплект входит инструмент для миграции с других фреймворков документации.

Ключевые возможности

  • 01Генерирует документацию из контента в Markdown и MDX
  • 02Создаёт страницы справки по API на основе спецификаций OpenAPI и GraphQL
  • 03Позволяет генерировать SDK по спецификациям API
  • 04Включает готовые темы и полнотекстовый поиск
  • 05Предоставляет интеграции с аналитикой, A/B-тестированием и онлайн-чатом
  • 06Позволяет настраивать компоненты и макеты

Сценарии использования

  • Публикация документации продукта для веб-приложения
  • Документирование REST- или GraphQL API с автоматически созданными страницами справки
  • Создание портала для разработчиков, где SDK доступны вместе с документацией API
  • Миграция существующего сайта документации с другого фреймворка

Быстрый старт

  1. 1

    Убедитесь, что установлен Node версии 22.12 или новее

  2. 2

    Установите xyd глобально с помощью bun

    bun add -g xyd-js
  3. 3

    Запустите сервер разработки

    xyd
  4. 4

    Соберите статические файлы документации

    xyd build

Что важно знать

  • Требуется Node версии 22.12 или новее.

В подборках

GraphQL API и клиенты для APIГенераторы статических сайтов и инструменты для документации

Темы

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

Частые вопросы

Что такое xyd?
Фреймворк для документации на TypeScript: собирает сайты из Markdown/MDX и генерирует документацию API по спецификациям OpenAPI и GraphQL. xyd — фреймворк для документации на TypeScript и React. Он превращает контент в Markdown и MDX в сайт документации. В комплекте есть сервер разработки с горячей перезагрузкой, который работает без настройки, а также команда для сборки статических файлов и их развёртывания.
xyd можно использовать бесплатно? Какая у него лицензия?
xyd распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.
xyd всё ещё поддерживается?
Активно поддерживается. Последний коммит в xyd — 29 окт. 2026 г..
Для чего можно использовать xyd?
Публикация документации продукта для веб-приложения Документирование REST- или GraphQL API с автоматически созданными страницами справки Создание портала для разработчиков, где SDK доступны вместе с документацией API Миграция существующего сайта документации с другого фреймворка
Как установить xyd?
Убедитесь, что установлен Node версии 22.12 или новее Установите xyd глобально с помощью bun: bun add -g xyd-js Запустите сервер разработки: xyd Соберите статические файлы документации: xyd build
Где скачать xyd?
Исходный код и инструкции по установке — на GitHub: https://github.com/livesession/xyd

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты