feat(storybook): add docsMode support (#2551)

nrwl · Feb 25, 2020 · cd25970 · cd25970
1 parent cbd5d4c
commit cd25970
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 2 deletions.
diff --git a/docs/angular/api-storybook/builders/build.md b/docs/angular/api-storybook/builders/build.md
@@ -6,6 +6,14 @@ Builder properties can be configured in angular.json when defining the builder,
 
 ## Properties
 
+### docsMode
+
+Default: `false`
+
+Type: `boolean`
+
+Build a documentation-only site using addon-docs.
+
 ### outputPath
 
 Type: `string`

diff --git a/docs/react/api-storybook/builders/build.md b/docs/react/api-storybook/builders/build.md
@@ -7,6 +7,14 @@ Read more about how to use builders and the CLI here: https://nx.dev/react/guide
 
 ## Properties
 
+### docsMode
+
+Default: `false`
+
+Type: `boolean`
+
+Build a documentation-only site using addon-docs.
+
 ### outputPath
 
 Type: `string`

diff --git a/docs/web/api-storybook/builders/build.md b/docs/web/api-storybook/builders/build.md
@@ -7,6 +7,14 @@ Read more about how to use builders and the CLI here: https://nx.dev/web/guides/
 
 ## Properties
 
+### docsMode
+
+Default: `false`
+
+Type: `boolean`
+
+Build a documentation-only site using addon-docs.
+
 ### outputPath
 
 Type: `string`

diff --git a/packages/storybook/src/builders/build-storybook/build-storybook.impl.ts b/packages/storybook/src/builders/build-storybook/build-storybook.impl.ts
@@ -27,6 +27,8 @@ export interface StorybookBuilderOptions extends JsonObject {
   uiFramework: string;
   config: StorybookConfig;
   quiet?: boolean;
+  outputPath?: string;
+  docsMode?: boolean;
 }
 
 try {
@@ -85,8 +87,8 @@ async function storybookOptionMapper(
     configDir: storybookConfig,
     ...frameworkOptions,
     frameworkPresets: [...(frameworkOptions.frameworkPresets || [])],
-
-    watch: false
+    watch: false,
+    docsMode: builderOptions.docsMode
   };
   optionsWithFramework.config;
   return optionsWithFramework;

diff --git a/packages/storybook/src/builders/build-storybook/schema.json b/packages/storybook/src/builders/build-storybook/schema.json
@@ -47,6 +47,11 @@
         }
       ]
     },
+    "docsMode": {
+      "type": "boolean",
+      "description": "Build a documentation-only site using addon-docs.",
+      "default": false
+    },
     "quiet": {
       "type": "boolean",
       "description": "Suppress verbose build output.",