Merge pull request #117 from event-catalog/create-catalog-v3

chore(sdk): updated default catalog config files for v3

Author: boyney123

.changeset/chatty-pans-walk.md

@@ -0,0 +1,5 @@
+---
+"@eventcatalog/create-eventcatalog": major
+---
+
+chore(sdk): updated default catalog config files for v3

templates/asyncapi/eventcatalog.config.js

@@ -18,6 +18,13 @@ export default {
   // Change to make the base url of the site different, by default https://{website}.com/docs,
   // changing to /company would be https://{website}.com/company/docs,
   base: '/',
+  // Customize the navigation for your docs sidebar.
+  // read more at https://eventcatalog.dev/docs/development/customization/customize-sidebars/documentation-sidebar
+  navigation: {
+    pages: [
+      'list:all',
+    ]
+  },
   logo: {
     alt: 'EventCatalog Logo',
     src: '/logo.png',
@@ -58,13 +65,6 @@ export default {
       },
     ],
   ],
-  docs: {
-    sidebar: {
-      // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
-      // LIST_VIEW will render the DOCS that look familiar to API documentation websites
-      type: 'LIST_VIEW'
-    },
-  },
   // Enable RSS feed for your eventcatalog
   rss: {
     enabled: true,

templates/confluent/eventcatalog.config.js

@@ -13,6 +13,13 @@ export default {
   // Change to make the base url of the site different, by default https://{website}.com/docs,
   // changing to /company would be https://{website}.com/company/docs,
   base: '/',
+  // Customize the navigation for your docs sidebar.
+  // read more at https://eventcatalog.dev/docs/development/customization/customize-sidebars/documentation-sidebar
+  navigation: {
+    pages: [
+      'list:all',
+    ]
+  },
   // Customize the logo, add your logo to public/ folder
   logo: {
     alt: 'EventCatalog Logo',
@@ -25,13 +32,6 @@ export default {
     // number of items to include in the feed per resource (event, service, etc)
     limit: 20
   },
-  docs: {
-    sidebar: {
-      // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
-      // LIST_VIEW will render the DOCS that look familiar to API documentation websites
-      type: 'LIST_VIEW'
-    },
-  },
   // required random generated id used by eventcatalog
   cId: '<cId>',
   // This lets you copy markdown contents from EventCatalog to your clipboard

templates/default/eventcatalog.config.js

@@ -13,25 +13,20 @@ export default {
   // Change to make the base url of the site different, by default https://{website}.com/docs,
   // changing to /company would be https://{website}.com/company/docs,
   base: '/',
+  // Customize the navigation for your docs sidebar.
+  // read more at https://eventcatalog.dev/docs/development/customization/customize-sidebars/documentation-sidebar
+  navigation: {
+    pages: [
+      'list:top-level-domains',
+      'list:all',
+    ]
+  },
   // Customize the logo, add your logo to public/ folder
   logo: {
     alt: 'EventCatalog Logo',
     src: '/logo.png',
     text: 'EventCatalog'
   },
-  docs: {
-    sidebar: {
-      // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
-      // LIST_VIEW will render the DOCS that look familiar to API documentation websites
-      type: 'LIST_VIEW'
-    },
-  },
-  // Enable RSS feed for your eventcatalog
-  rss: {
-    enabled: true,
-    // number of items to include in the feed per resource (event, service, etc)
-    limit: 20
-  },
   // This lets you copy markdown contents from EventCatalog to your clipboard
   // Including schemas for your events and services
   llmsTxt: {

templates/empty/eventcatalog.config.js

@@ -13,30 +13,24 @@ export default {
   // Change to make the base url of the site different, by default https://{website}.com/docs,
   // changing to /company would be https://{website}.com/company/docs,
   base: '/',
+  // Customize the navigation for your docs sidebar.
+  // read more at https://eventcatalog.dev/docs/development/customization/customize-sidebars/documentation-sidebar
+  navigation: {
+    pages: [
+      'list:all',
+    ]
+  },
   // Customize the logo, add your logo to public/ folder
   logo: {
     alt: 'EventCatalog Logo',
     src: '/logo.png',
     text: 'EventCatalog'
   },
-  // Enable RSS feed for your eventcatalog
-  rss: {
-    enabled: true,
-    // number of items to include in the feed per resource (event, service, etc)
-    limit: 20
-  },
   // This lets you copy markdown contents from EventCatalog to your clipboard
   // Including schemas for your events and services
   llmsTxt: {
     enabled: true,
   },
-  docs: {
-    sidebar: {
-      // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
-      // LIST_VIEW will render the DOCS that look familiar to API documentation websites
-      type: 'LIST_VIEW'
-    },
-  },
   // required random generated id used by eventcatalog
   cId: '<cId>'
 }

templates/eventbridge/eventcatalog.config.js

@@ -13,6 +13,13 @@ export default {
   // Change to make the base url of the site different, by default https://{website}.com/docs,
   // changing to /company would be https://{website}.com/company/docs,
   base: '/',
+  // Customize the navigation for your docs sidebar.
+  // read more at https://eventcatalog.dev/docs/development/customization/customize-sidebars/documentation-sidebar
+  navigation: {
+    pages: [
+      'list:all',
+    ]
+  },
   // Customize the logo, add your logo to public/ folder
   logo: {
     alt: 'EventCatalog Logo',
@@ -25,13 +32,6 @@ export default {
     // number of items to include in the feed per resource (event, service, etc)
     limit: 20
   },
-  docs: {
-    sidebar: {
-      // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
-      // LIST_VIEW will render the DOCS that look familiar to API documentation websites
-      type: 'LIST_VIEW'
-    },
-  },
   // This lets you copy markdown contents from EventCatalog to your clipboard
   // Including schemas for your events and services
   llmsTxt: {

templates/graphql/eventcatalog.config.js

@@ -18,6 +18,13 @@ export default {
   // Change to make the base url of the site different, by default https://{website}.com/docs,
   // changing to /company would be https://{website}.com/company/docs,
   base: "/",
+  // Customize the navigation for your docs sidebar.
+  // read more at https://eventcatalog.dev/docs/development/customization/customize-sidebars/documentation-sidebar
+  navigation: {
+    pages: [
+      'list:all',
+    ]
+  },
   // Customize the logo, add your logo to public/ folder
   logo: {
     alt: "EventCatalog Logo",
@@ -49,12 +56,6 @@ export default {
       },
     ],
   ],
-  // Enable RSS feed for your eventcatalog
-  rss: {
-    enabled: true,
-    // number of items to include in the feed per resource (event, service, etc)
-    limit: 20
-  },
   // required random generated id used by eventcatalog
   cId: '<cId>'
 };

templates/openapi/eventcatalog.config.js

@@ -18,6 +18,13 @@ export default {
   // Change to make the base url of the site different, by default https://{website}.com/docs,
   // changing to /company would be https://{website}.com/company/docs,
   base: "/",
+  // Customize the navigation for your docs sidebar.
+  // read more at https://eventcatalog.dev/docs/development/customization/customize-sidebars/documentation-sidebar
+  navigation: {
+    pages: [
+      'list:all',
+    ]
+  },
   // Customize the logo, add your logo to public/ folder
   logo: {
     alt: "EventCatalog Logo",
@@ -63,19 +70,6 @@ export default {
       },
     ],
   ],
-  docs: {
-    sidebar: {
-      // TREE_VIEW will render the DOCS as a tree view and map your file system folder structure
-      // LIST_VIEW will render the DOCS that look familiar to API documentation websites
-      type: 'LIST_VIEW'
-    },
-  },
-  // Enable RSS feed for your eventcatalog
-  rss: {
-    enabled: true,
-    // number of items to include in the feed per resource (event, service, etc)
-    limit: 20
-  },
   // required random generated id used by eventcatalog
   cId: '<cId>'
 };