預覽與建置文件

Storybook 可讓您建立豐富且廣泛的文件，這將有助於您和任何其他參與開發流程的利害關係人。開箱即用，您擁有不僅能撰寫文件，還能預覽和建置文件所需的工具。

預覽 Storybook 的文件

在開發過程中的任何時間點，您都可以預覽您撰寫的文件。當您使用 --docs 標誌時，Storybook 可讓您產生最終文件的預覽。我們建議將其作為新的腳本包含在您的 package.json 中

{
  "scripts": {
    "storybook-docs": "storybook dev --docs"
  }
}

根據您的設定，當您執行 storybook-docs 腳本時。Storybook 將會進入文件模式，並產生不同的建置。

它會尋找 MDX 或 CSF 中可用的任何 story，並根據您新增的文件顯示它...

Storybook in documentation mode

此建置模式相較於一般 Storybook 建置有一些注意事項

您也可以發佈您的文件，就像您發佈您的 Storybook 一樣。您可以搭配 storybook build 命令使用 --docs 標誌。我們也建議將其作為腳本包含在您的 package.json 檔案中

{
  "scripts": {
    "build-storybook-docs": "storybook build --docs"
  }
}

根據您擁有的設定，當執行 build-storybook-docs 腳本時，Storybook 將再次進入文件模式，並產生不同的建置，並將文件輸出到 storybook-static 資料夾中。

上述相同的注意事項將會適用。

您可以使用任何主機供應商來部署您的文件，例如

深入了解 Storybook 文件