如何撰寫元件文件
當你在開發期間撰寫元件 stories 時,你同時也建立了基礎文件,以便日後回顧。
Storybook 提供工具讓你擴展這些基本文件,加入散文和版面配置,突顯你的元件和 stories。這讓你能夠建立 UI 函式庫使用指南、設計系統網站等等。
如果你是首次在專案中加入 Storybook,我們會為你提供一個文件頁面(簡稱「Autodocs」),位於你的 stories 附近。這是一個自動產生的基準範本,列出你現有的 stories 和相關元數據。
此外,如果需要,你可以自訂此範本,或使用 MDX 為每個元件建立自由格式的頁面。在這兩種情況下,你都會使用 Doc Blocks 作為建構區塊來建立功能完整的文件。
文件已自動設定為在大多數情況下開箱即用。在某些情況下,你可能需要或想要調整設定。請在此處閱讀更多相關資訊:這裡。