如何撰寫元件文件

當您在開發期間撰寫元件 stories 時，您也會建立基本文件以供稍後回顧。

Storybook 提供您工具來擴展此基本文件，使用散文和版面配置來突出顯示您的元件和 stories。這讓您可以建立 UI 函式庫使用指南、設計系統網站等等。

如果您是第一次將 Storybook 包含在您的專案中，我們會提供您一個位於 stories 附近的文件頁面（簡稱「自動文件」）。這是一個自動產生的基準範本，列出您現有的 stories 和相關中繼資料。

此外，如果需要，您可以自訂此範本，或使用 MDX 為每個元件建立自由格式的頁面。在這兩種情況下，您都會使用文件區塊作為建構完整功能文件的基本要素。

文件已自動設定為在大多數使用情況下開箱即用。在某些情況下，您可能需要或想要調整設定。閱讀更多相關資訊 這裡。