デザインシステムドキュメントを確認できることでデザイン負債を最小化につながります。

UIライブラリとコードコンポーネントに関するすべての情報を一元化するために、**Merge Design System Documentation(Mergeデザインシステムドキュメント)**を開発しました。

ライブラリにあるすべてのコンポーネントの詳細や各要素でのユースケースの共有、バージョン再作成のために役立ちます。

デザインシステム連携方法

コードベースのデザインライブラリのドキュメントを自動生成するには、まず、UXPinのDesign Systemと連携させる必要があります。

これには以下2つの方法があります。:

  1. デザインシステムに移動し、左側にあるカテゴリからMergeを選択します。ドキュメントを自動生成するために、ドロップダウンリストから該当するMergeのライブラリを選択します。
  2. エディタに移動してライブラリを選択します。ライブラリ設定の歯車⚙アイコンを開き、デザインシステムと連携します。すでにお持ちのデザインシステムを選択するか、新しく追加してください。

コードに含まれるすべてのコンポーネント、バージョン、プロパティ、説明などの情報が自動的にドキュメントに表示されます。

Small Merge Documentation Video.mov

<aside> 🖇️ 備考

MergeデザインシステムドキュメントはGit統合のみ利用可能です。

</aside>

情報の編集

自動生成されたドキュメントの全ての情報と名前を編集して追加することができます。

ドキュメントだけでなく、コンポーネントのプロパティと説明も含めて変更したい場合は、Mergeコンポーネントマネージャーにアクセスしてください。

Small Merge docs 2.mov