feat: add storyPaths page option

ccontrols · Jul 3, 2020 · 563add3 · 563add3
1 parent 2ecb69b
commit 563add3
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/core/core/src/configuration.ts b/core/core/src/configuration.ts
@@ -35,6 +35,11 @@ export interface PageConfiguration {
    */
   basePath?: string;
 
+  /**
+   * if true, generate story-based paths. This is for documents with sidebars that allow selection of stories
+   */
+  storyPaths?: boolean;
+
   /**
    * label - used for menu labels
    */
@@ -82,7 +87,7 @@ type WebpackConfig = WebpackConfiguration | WebpackConfigFn;
 
 export type PagesOnlyRoutes = Record<
   PageType,
-  Pick<PageConfiguration, 'basePath'> & {
+  Pick<PageConfiguration, 'basePath' | 'storyPaths'> & {
     tabs?: Pick<TabConfiguration, 'route'>[];
   }
 >;
@@ -241,6 +246,7 @@ export const defaultBuildConfig: BuildConfiguration = {
   pages: {
     story: {
       basePath: 'docs/',
+      storyPaths: true,
       tabs: [{ route: 'page' }, { route: 'test' }],
     },
     blog: {

diff --git a/integrations/gatsby-theme-stories/src/gatsby-node.ts b/integrations/gatsby-theme-stories/src/gatsby-node.ts
@@ -43,7 +43,10 @@ exports.createPages = async (
           tabs.forEach((tab, tabIndex) => {
             const route = tabIndex > 0 ? tab.route : undefined;
             docs.forEach(doc => {
-              const stories = doc.stories?.length ? doc.stories : [undefined];
+              const stories =
+                page.storyPaths && doc.stories?.length
+                  ? doc.stories
+                  : [undefined];
               stories.forEach((storyId?: string) => {
                 const url = getStoryPath(
                   storyId,