livesession/xyd

これは何？

主な機能

• 01MarkdownやMDXのコンテンツからドキュメントを生成
• 02OpenAPIやGraphQLの仕様からAPIリファレンスページを構築
• 03API仕様に基づくSDK生成に対応
• 04組み込みテーマと全文検索を搭載
• 05分析、A/Bテスト、ライブチャットとの連携を提供
• 06コンポーネントやレイアウトをカスタマイズ可能

ユースケース

• Webアプリケーションの製品ドキュメントを公開する
• 生成されたリファレンスページを使ってREST APIやGraphQL APIを文書化する
• APIドキュメントとあわせてSDKを提供する開発者ポータルを構築する
• 既存のドキュメントサイトを別のフレームワークから移行する

クイックスタート

1. 1

   Node 22.12以降がインストールされていることを確認します

2. 2

   bunを使ってxydをグローバルにインストールします

   bun add -g xyd-js
3. 3

   開発サーバーを起動します

   xyd
4. 4

   静的ドキュメントファイルをビルドします

   xyd build

使う前に知っておきたいこと

• !Node 22.12以降が必要です。

収録されている特集

トピック

よくある質問

xyd とは？

Markdown/MDXからドキュメントサイトを構築し、OpenAPIやGraphQLのAPIドキュメントも生成できるTypeScript製フレームワーク。 xydはTypeScriptとReactで構築されたドキュメントフレームワークです。MarkdownやMDXのコンテンツからドキュメントサイトを作成でき、設定不要で使えるホットリロード対応の開発サーバーと、デプロイ用の静的ファイルをビルドするコマンドも備えています。

xyd は無料で使えますか？ライセンスは？

xyd は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。

xyd は今もメンテナンスされていますか？

活発にメンテナンス中。xyd の最終コミットは 2026年10月29日 です。

xyd は何に使えますか？

Webアプリケーションの製品ドキュメントを公開する 生成されたリファレンスページを使ってREST APIやGraphQL APIを文書化する APIドキュメントとあわせてSDKを提供する開発者ポータルを構築する 既存のドキュメントサイトを別のフレームワークから移行する

xyd のインストール方法は？

Node 22.12以降がインストールされていることを確認します bunを使ってxydをグローバルにインストールします: bun add -g xyd-js 開発サーバーを起動します: xyd 静的ドキュメントファイルをビルドします: xyd build

xyd はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/livesession/xyd