xyd

xyd — это фреймворк для документации, который позволяет создавать профессиональные сайты документации без необходимости разбираться в сложных инструментах. В комплекте есть шесть красивых встроенных тем, которые вы можете использовать сразу, или настроить каждую часть под ваш бренд. Фреймворк автоматически генерирует документацию на основе ваших спецификаций OpenAPI, GraphQL, TypeScript и React.

В отличие от других инструментов для документации, xyd включает всё необходимое с самого начала. Вы получаете полнотекстовый поиск с умными подсказками, встроенную аналитику для отслеживания того, как люди используют вашу документацию, интеграцию с живым чатом и даже возможности A/B тестирования. Сервер разработки запускается мгновенно с горячей перезагрузкой, поэтому изменения видны сразу. Созданный разработчиками для разработчиков, xyd избавляет от скучных частей создания документации, чтобы вы могли сосредоточиться на написании отличного контента.

Начать работу с xyd очень просто. Вот шаги для создания вашей документации:

• Установите xyd глобально с помощью команды bun add -g xyd-js или вашего предпочитаемого менеджера пакетов. На вашем компьютере должна быть установлена версия Node.js 22.12 или выше.

• Запустите xyd в папке вашего проекта, чтобы запустить сервер разработки. Он запускается мгновенно с горячей перезагрузкой, что означает, что вы сразу увидите изменения без необходимости перезапуска.

• Выберите одну из шести встроенных тем или создайте собственный дизайн. Каждая тема предлагает разный стиль и макет, чтобы соответствовать потребностям вашего проекта.

• Пишите вашу документацию, используя расширенную систему контента, которая поддерживает интерактивные компоненты, живые примеры кода и динамические элементы, делающие вашу документацию более увлекательной.

• Для документации API просто укажите xyd ваши спецификации OpenAPI, GraphQL, TypeScript или React, и он автоматически сгенерирует красивую документацию.

• Запустите xyd build, когда будете готовы создать статические файлы для развертывания на любом хостинге.

• Доступно шесть красивых встроенных тем

• Автоматическая документация API из OpenAPI, GraphQL, TypeScript, React

• Сервер разработки с горячей перезагрузкой и нулевой конфигурацией

• Полная настройка всех компонентов и макетов

• Богатая экосистема плагинов для поиска, аналитики, чата

• Интерактивные примеры кода и динамический контент

• Встроенная аналитика и поддержка A/B тестирования

• Молниеносный полнотекстовый поиск

• Открытый исходный код и полностью бесплатный

• Инструменты миграции с других фреймворков