xyd — це безкоштовний відкритий фреймворк для документації, який допомагає розробникам легко створювати швидкі, красиві та інтерактивні сайти документації.
Що таке xyd
xyd — це фреймворк для документації, який дозволяє створювати професійні вебсайти документації без боротьби зі складними інструментами. Він постачається з шістьма гарними вбудованими темами, які ви можете використовувати одразу, або ж налаштувати кожну частину під свій бренд. Фреймворк автоматично генерує документацію з ваших специфікацій OpenAPI, GraphQL, TypeScript та React.
На відміну від інших інструментів для документації, xyd включає все необхідне з самого початку. Ви отримуєте повнотекстовий пошук зі смарт-пропозиціями, вбудовану аналітику для відстеження того, як користувачі взаємодіють з вашою документацією, інтеграцію живого чату та навіть можливості A/B тестування. Сервер розробки запускається миттєво з гарячим перезавантаженням, тож ви бачите зміни одразу. Створений розробниками для розробників, xyd позбавляє нудних частин створення документації, щоб ви могли зосередитися на написанні чудового контенту.
Як використовувати xyd
Початок роботи з xyd є простим. Ось кроки для створення вашої документації:
Встановіть xyd глобально за допомогою команди
bun add -g xyd-jsабо вашого улюбленого менеджера пакетів. Вам потрібна версія Node.js 22.12 або вище, встановлена на вашому комп’ютері.Запустіть
xydу папці вашого проєкту, щоб розпочати сервер розробки. Він запускається миттєво з гарячим перезавантаженням, що означає, що ви можете одразу бачити зміни без перезапуску.Виберіть одну з шести вбудованих тем або створіть власний дизайн. Кожна тема пропонує різний стиль і макет, щоб відповідати потребам вашого проєкту.
Пишіть вашу документацію, використовуючи розширену систему контенту, яка підтримує інтерактивні компоненти, живі приклади коду та динамічні елементи, що роблять ваші документи більш захопливими.
Для API-документації просто вкажіть xyd на ваші специфікації OpenAPI, GraphQL, TypeScript або React, і він автоматично згенерує гарну документацію.
Запустіть
xyd build, коли будете готові створити статичні файли для розгортання на будь-якому хостингу.
Функції xyd
Шість красивих вбудованих тем
Автоматична документація API з OpenAPI, GraphQL, TypeScript, React
Сервер розробки з гарячим перезавантаженням без налаштувань
Повна кастомізація всіх компонентів і макетів
Багатий екосистема плагінів для пошуку, аналітики, чату
Інтерактивні приклади коду та динамічний контент
Вбудована аналітика та підтримка A/B тестування
Миттєвий повнотекстовий пошук
Відкритий код і повністю безкоштовний
Інструменти міграції з інших фреймворків
Ціноутворення xyd
Free
Free
- Повний фреймворк з відкритим вихідним кодом
- Шість вбудованих тем (Solar, Gusto, Poetry, Picasso, Opener, Cosmo)
- Автоматичне генерування документації API (OpenAPI, GraphQL, TypeScript, React)
- Сервер розробки з гарячим перезавантаженням
- Нульова конфігурація налаштувань
- Повні можливості налаштування
- Розвинена екосистема плагінів
- Пошук за повним текстом з урахуванням помилок друку
- Вбудована інтеграція аналітики
- Підтримка A/B тестування
Випадки використання xyd
Хто може отримати користь від xyd
Репозиторій xyd
Переглянути на Github| Зірки | 90 |
| Форки | 5 |
| Вік репозиторію | 1 рік |
| Останній коміт | 1 місяць тому |
Часті запитання про xyd
Поділіться своїм досвідом з xyd
Подивіться, що користувачі кажуть про xyd
0 Огляди
Ще немає оглядів
Будьте першим, хто напише огляд xyd
Вбудувати значки xyd
Покажіть своїй спільноті, що xyd представлений на Tool Questor. Додайте ці красиві значки на свій веб-сайт, документацію або соціальні профілі, щоб підвищити довіру та залучити більше трафіку.
