xyd

xydは、複雑なツールに悩まされることなく、プロフェッショナルなドキュメントウェブサイトを作成できるドキュメンテーションフレームワークです。すぐに使える美しい6つの組み込みテーマが付属しており、ブランドに合わせてすべての部分をカスタマイズすることも可能です。このフレームワークは、OpenAPI、GraphQL、TypeScript、Reactのコード仕様から自動的にドキュメントを生成します。

他のドキュメンテーションツールとは異なり、xydは最初から必要なすべてを備えています。スマートなサジェスト機能付きの全文検索、ドキュメントの利用状況を追跡する組み込みの分析機能、ライブチャットの統合、さらにはA/Bテスト機能も利用可能です。開発サーバーはホットリロードで即座に起動し、変更をすぐに確認できます。開発者によって開発者のために作られたxydは、ドキュメント作成の退屈な部分を取り除き、優れたコンテンツの執筆に集中できるようにします。

xydの使い始めは簡単です。ドキュメントを作成する手順は以下の通りです：

• bun add -g xyd-js コマンドまたはお好みのパッケージマネージャーを使ってxydをグローバルにインストールします。コンピュータにはNode.jsバージョン22.12以上が必要です。

• プロジェクトフォルダでxydを実行して開発サーバーを起動します。ホットリロード機能により、再起動せずに変更が即座に反映されます。

• 6つの組み込みテーマから選ぶか、独自のカスタムデザインを作成できます。各テーマは異なるスタイルとレイアウトを提供し、プロジェクトのニーズに合わせられます。

• インタラクティブなコンポーネント、ライブコード例、動的要素をサポートするリッチコンテンツフレームワークを使ってドキュメントを書き、より魅力的にします。

• APIドキュメントの場合は、xydにOpenAPI、GraphQL、TypeScript、またはReactの仕様を指定するだけで、美しいドキュメントが自動生成されます。

• 準備ができたらxyd buildを実行して、任意のホスティングサービスにデプロイ可能な静的ファイルを作成します。

• 美しい6つの組み込みテーマを利用可能

• OpenAPI、GraphQL、TypeScript、Reactからの自動APIドキュメント生成

• ゼロ設定のホットリロード開発サーバー

• すべてのコンポーネントとレイアウトの完全カスタマイズ

• 検索、分析、チャットのための豊富なプラグインエコシステム

• インタラクティブなコード例と動的コンテンツ

• 組み込みの分析およびA/Bテストサポート

• 超高速な全文検索機能

• オープンソースで完全無料

• 他のフレームワークからの移行ツール