Fixed docusaurus build (#6496)

The `docs` and `api` folders where moved into the `docs` folder so only one preset could be used. Also had to rename a removed docusaurus options and fix broken links. I deleted a `docs/README.mdx` file that seemed no longer in used and contained a broken link. * Merge docusaurus website presets * Renamed removed docusaurus option * Fixed broken links * Removed README.mdx as it seems to be a unused leftover Co-authored-by: Guy Carmeli <guyca@users.noreply.github.com>
wix · Aug 23, 2020 · 5dfbcfe · 5dfbcfe
1 parent 12a615b
commit 5dfbcfe
Show file tree

Hide file tree

Showing 75 changed files with 75 additions and 121 deletions.
diff --git a/website/docs/README.mdx b/website/docs/README.mdx
diff --git a/website/api/api-component.mdx → website/docs/api/api-component.mdx b/website/api/api-component.mdx → website/docs/api/api-component.mdx
diff --git a/website/api/api-events.mdx → website/docs/api/api-events.mdx b/website/api/api-events.mdx → website/docs/api/api-events.mdx
diff --git a/website/api/api-modal.mdx → website/docs/api/api-modal.mdx b/website/api/api-modal.mdx → website/docs/api/api-modal.mdx
diff --git a/website/api/api-options.mdx → website/docs/api/api-options.mdx b/website/api/api-options.mdx → website/docs/api/api-options.mdx
diff --git a/website/api/api-overlay.mdx → website/docs/api/api-overlay.mdx b/website/api/api-overlay.mdx → website/docs/api/api-overlay.mdx
diff --git a/website/api/api-root.mdx → website/docs/api/api-root.mdx b/website/api/api-root.mdx → website/docs/api/api-root.mdx
diff --git a/website/api/api-sideMenu.mdx → website/docs/api/api-sideMenu.mdx b/website/api/api-sideMenu.mdx → website/docs/api/api-sideMenu.mdx
diff --git a/website/api/api-stack.mdx → website/docs/api/api-stack.mdx b/website/api/api-stack.mdx → website/docs/api/api-stack.mdx
diff --git a/website/api/layout-BottomTabs.mdx → website/docs/api/layout-BottomTabs.mdx b/website/api/layout-BottomTabs.mdx → website/docs/api/layout-BottomTabs.mdx
diff --git a/website/api/layout-component.mdx → website/docs/api/layout-component.mdx b/website/api/layout-component.mdx → website/docs/api/layout-component.mdx
diff --git a/website/api/layout-layout.mdx → website/docs/api/layout-layout.mdx b/website/api/layout-layout.mdx → website/docs/api/layout-layout.mdx
diff --git a/website/api/layout-sideMenu.mdx → website/docs/api/layout-sideMenu.mdx b/website/api/layout-sideMenu.mdx → website/docs/api/layout-sideMenu.mdx
diff --git a/website/api/layout-splitView.mdx → website/docs/api/layout-splitView.mdx b/website/api/layout-splitView.mdx → website/docs/api/layout-splitView.mdx
diff --git a/website/api/layout-stack.mdx → website/docs/api/layout-stack.mdx b/website/api/layout-stack.mdx → website/docs/api/layout-stack.mdx
diff --git a/website/api/options-animations.mdx → website/docs/api/options-animations.mdx b/website/api/options-animations.mdx → website/docs/api/options-animations.mdx
diff --git a/website/api/options-backButton.mdx → website/docs/api/options-backButton.mdx b/website/api/options-backButton.mdx → website/docs/api/options-backButton.mdx
diff --git a/website/api/options-background.mdx → website/docs/api/options-background.mdx b/website/api/options-background.mdx → website/docs/api/options-background.mdx
diff --git a/website/api/options-bottomTab.mdx → website/docs/api/options-bottomTab.mdx b/website/api/options-bottomTab.mdx → website/docs/api/options-bottomTab.mdx
diff --git a/website/api/options-bottomTabs.mdx → website/docs/api/options-bottomTabs.mdx b/website/api/options-bottomTabs.mdx → website/docs/api/options-bottomTabs.mdx
diff --git a/website/api/options-button.mdx → website/docs/api/options-button.mdx b/website/api/options-button.mdx → website/docs/api/options-button.mdx
diff --git a/website/api/options-fab.mdx → website/docs/api/options-fab.mdx b/website/api/options-fab.mdx → website/docs/api/options-fab.mdx
diff --git a/website/api/options-iconInsets.mdx → website/docs/api/options-iconInsets.mdx b/website/api/options-iconInsets.mdx → website/docs/api/options-iconInsets.mdx
diff --git a/website/api/options-largeTitle.mdx → website/docs/api/options-largeTitle.mdx b/website/api/options-largeTitle.mdx → website/docs/api/options-largeTitle.mdx
@@ -40,7 +40,7 @@ Large title text color.
 
 ### `fontFamily`
 
-Set the large title [FontFamily](fonts.mdx).
+Set the large title [FontFamily](../docs/style-fonts.mdx).
 
 | Type       | Required | Platform |
 | ---------- | -------- | -------- |

diff --git a/website/api/options-layout.mdx → website/docs/api/options-layout.mdx b/website/api/options-layout.mdx → website/docs/api/options-layout.mdx
diff --git a/website/api/options-migration.mdx → website/docs/api/options-migration.mdx b/website/api/options-migration.mdx → website/docs/api/options-migration.mdx
diff --git a/website/api/options-modal.mdx → website/docs/api/options-modal.mdx b/website/api/options-modal.mdx → website/docs/api/options-modal.mdx
diff --git a/website/api/options-navigationBar.mdx → website/docs/api/options-navigationBar.mdx b/website/api/options-navigationBar.mdx → website/docs/api/options-navigationBar.mdx
diff --git a/website/api/options-overlay.mdx → website/docs/api/options-overlay.mdx b/website/api/options-overlay.mdx → website/docs/api/options-overlay.mdx
diff --git a/website/api/options-preview.mdx → website/docs/api/options-preview.mdx b/website/api/options-preview.mdx → website/docs/api/options-preview.mdx
diff --git a/website/api/options-root.mdx → website/docs/api/options-root.mdx b/website/api/options-root.mdx → website/docs/api/options-root.mdx
diff --git a/website/api/options-sideMenu.mdx → website/docs/api/options-sideMenu.mdx b/website/api/options-sideMenu.mdx → website/docs/api/options-sideMenu.mdx
diff --git a/website/api/options-sideMenuSide.mdx → website/docs/api/options-sideMenuSide.mdx b/website/api/options-sideMenuSide.mdx → website/docs/api/options-sideMenuSide.mdx
diff --git a/website/api/options-splitView.mdx → website/docs/api/options-splitView.mdx b/website/api/options-splitView.mdx → website/docs/api/options-splitView.mdx
diff --git a/website/api/options-stack.mdx → website/docs/api/options-stack.mdx b/website/api/options-stack.mdx → website/docs/api/options-stack.mdx
diff --git a/website/api/options-statusBar.mdx → website/docs/api/options-statusBar.mdx b/website/api/options-statusBar.mdx → website/docs/api/options-statusBar.mdx
diff --git a/website/api/options-subtitle.mdx → website/docs/api/options-subtitle.mdx b/website/api/options-subtitle.mdx → website/docs/api/options-subtitle.mdx
diff --git a/website/api/options-title.mdx → website/docs/api/options-title.mdx b/website/api/options-title.mdx → website/docs/api/options-title.mdx
diff --git a/website/docs/community-libraries.mdx → website/docs/docs/community-libraries.mdx b/website/docs/community-libraries.mdx → website/docs/docs/community-libraries.mdx
diff --git a/website/docs/docs-Installing.mdx → website/docs/docs/docs-Installing.mdx b/website/docs/docs-Installing.mdx → website/docs/docs/docs-Installing.mdx
diff --git a/website/docs/docs-advanced-navigation.mdx → ...te/docs/docs/docs-advanced-navigation.mdx b/website/docs/docs-advanced-navigation.mdx → ...te/docs/docs/docs-advanced-navigation.mdx
diff --git a/website/docs/docs-app-launch.mdx → website/docs/docs/docs-app-launch.mdx b/website/docs/docs-app-launch.mdx → website/docs/docs/docs-app-launch.mdx
diff --git a/website/docs/docs-basic-navigation.mdx → website/docs/docs/docs-basic-navigation.mdx b/website/docs/docs-basic-navigation.mdx → website/docs/docs/docs-basic-navigation.mdx
@@ -92,7 +92,7 @@ In the previous section we created a stack and initialized it with a single chil
 
 In order to push another screen to the stack, we will add a button to the home screen and call `Navigation.push`. The 'push' command accepts two parameters, the first is the id used to indicate into which stack to push the screen and the second is the screen we're pushing. After pushing a screen, a back button is added automatically to the TopBar so the users can navigate easily back to the previous screen.
 
-You can read more about the stack layout [here](stack.mdx) or dive right into the API [here](../api/layout-stack).
+You can read more about the stack layout [here](docs-stack.mdx) or dive right into the API [here](../api/layout-stack).
 
 :::info componentId
 Each React component registered with `Navigation.registerComponent` is assigned a unique `componentId` by Navigation. This unique id is used with Navigation commands (like the push command) to indicate into which stack we'd like to push. In this case, by using the componentId of the Home screen, we are telling Navigation to push into the stack containing the Home screen.

diff --git a/website/docs/docs-before-you-start.mdx → website/docs/docs/docs-before-you-start.mdx b/website/docs/docs-before-you-start.mdx → website/docs/docs/docs-before-you-start.mdx
diff --git a/website/docs/docs-bottomTabs.mdx → website/docs/docs/docs-bottomTabs.mdx b/website/docs/docs-bottomTabs.mdx → website/docs/docs/docs-bottomTabs.mdx
diff --git a/website/docs/docs-externalComponent.mdx → website/docs/docs/docs-externalComponent.mdx b/website/docs/docs-externalComponent.mdx → website/docs/docs/docs-externalComponent.mdx
diff --git a/website/docs/docs-functional-components.mdx → .../docs/docs/docs-functional-components.mdx b/website/docs/docs-functional-components.mdx → .../docs/docs/docs-functional-components.mdx
diff --git a/website/docs/docs-modal.mdx → website/docs/docs/docs-modal.mdx b/website/docs/docs-modal.mdx → website/docs/docs/docs-modal.mdx
diff --git a/website/docs/docs-overlay.mdx → website/docs/docs/docs-overlay.mdx b/website/docs/docs-overlay.mdx → website/docs/docs/docs-overlay.mdx
diff --git a/.../docs/docs-passing-data-to-components.mdx → .../docs/docs-passing-data-to-components.mdx b/.../docs/docs-passing-data-to-components.mdx → .../docs/docs-passing-data-to-components.mdx
diff --git a/website/docs/docs-playground-app.mdx → website/docs/docs/docs-playground-app.mdx b/website/docs/docs-playground-app.mdx → website/docs/docs/docs-playground-app.mdx
diff --git a/website/docs/docs-root.mdx → website/docs/docs/docs-root.mdx b/website/docs/docs-root.mdx → website/docs/docs/docs-root.mdx
diff --git a/website/docs/docs-screen-lifecycle.mdx → website/docs/docs/docs-screen-lifecycle.mdx b/website/docs/docs-screen-lifecycle.mdx → website/docs/docs/docs-screen-lifecycle.mdx
diff --git a/website/docs/docs-showcases.mdx → website/docs/docs/docs-showcases.mdx b/website/docs/docs-showcases.mdx → website/docs/docs/docs-showcases.mdx
diff --git a/website/docs/docs-sideMenu.mdx → website/docs/docs/docs-sideMenu.mdx b/website/docs/docs-sideMenu.mdx → website/docs/docs/docs-sideMenu.mdx
diff --git a/website/docs/docs-stack.mdx → website/docs/docs/docs-stack.mdx b/website/docs/docs-stack.mdx → website/docs/docs/docs-stack.mdx
diff --git a/website/docs/meta-contributing.mdx → website/docs/docs/meta-contributing.mdx b/website/docs/meta-contributing.mdx → website/docs/docs/meta-contributing.mdx
diff --git a/website/docs/sideMenu-disable.mdx → website/docs/docs/sideMenu-disable.mdx b/website/docs/sideMenu-disable.mdx → website/docs/docs/sideMenu-disable.mdx
diff --git a/website/docs/stack-backButton.mdx → website/docs/docs/stack-backButton.mdx b/website/docs/stack-backButton.mdx → website/docs/docs/stack-backButton.mdx
diff --git a/website/docs/stack-backNavigation.mdx → website/docs/docs/stack-backNavigation.mdx b/website/docs/stack-backNavigation.mdx → website/docs/docs/stack-backNavigation.mdx
diff --git a/website/docs/stack-buttons.mdx → website/docs/docs/stack-buttons.mdx b/website/docs/stack-buttons.mdx → website/docs/docs/stack-buttons.mdx
diff --git a/website/docs/stack-programmatically.mdx → website/docs/docs/stack-programmatically.mdx b/website/docs/stack-programmatically.mdx → website/docs/docs/stack-programmatically.mdx
diff --git a/website/docs/style-animations.mdx → website/docs/docs/style-animations.mdx b/website/docs/style-animations.mdx → website/docs/docs/style-animations.mdx
diff --git a/website/docs/style-constants.mdx → website/docs/docs/style-constants.mdx b/website/docs/style-constants.mdx → website/docs/docs/style-constants.mdx
diff --git a/website/docs/style-fonts.mdx → website/docs/docs/style-fonts.mdx b/website/docs/style-fonts.mdx → website/docs/docs/style-fonts.mdx
diff --git a/website/docs/style-orientation.mdx → website/docs/docs/style-orientation.mdx b/website/docs/style-orientation.mdx → website/docs/docs/style-orientation.mdx
diff --git a/website/docs/style-screens.mdx → website/docs/docs/style-screens.mdx b/website/docs/style-screens.mdx → website/docs/docs/style-screens.mdx
diff --git a/website/docs/style-statusbar.mdx → website/docs/docs/style-statusbar.mdx b/website/docs/style-statusbar.mdx → website/docs/docs/style-statusbar.mdx
diff --git a/website/docs/style-theme.mdx → website/docs/docs/style-theme.mdx b/website/docs/style-theme.mdx → website/docs/docs/style-theme.mdx
diff --git a/website/docs/third-party-mobx.mdx → website/docs/docs/third-party-mobx.mdx b/website/docs/third-party-mobx.mdx → website/docs/docs/third-party-mobx.mdx
diff --git a/website/docs/third-party-react-context.mdx → ...e/docs/docs/third-party-react-context.mdx b/website/docs/third-party-react-context.mdx → ...e/docs/docs/third-party-react-context.mdx
diff --git a/website/docs/third-party-typescript.mdx → website/docs/docs/third-party-typescript.mdx b/website/docs/third-party-typescript.mdx → website/docs/docs/third-party-typescript.mdx
diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -18,9 +18,9 @@ module.exports = {
         alt: 'React Native Navigation Logo',
         src: 'img/logo.png',
       },
-      links: [
-        {to: 'docs/before-you-start', label: 'Docs', position: 'left', activeBasePath: 'docs'},
-        {to: 'api/component', label: 'API', position: 'left', activeBasePath: 'api'},
+      items: [
+        { to: 'docs/before-you-start', label: 'Docs', position: 'left', activeBasePath: 'docs' },
+        { to: 'api/component', label: 'API', position: 'left', activeBasePath: 'api' },
         {
           href: 'https://github.com/wix/react-native-navigation',
           label: 'GitHub',
@@ -30,7 +30,7 @@ module.exports = {
     },
     algolia: {
       apiKey: '6d8c985d9db80241d117497afe2a0e8c',
-      indexName: 'wix_react-native-navigation'
+      indexName: 'wix_react-native-navigation',
     },
     sidebarCollapsible: false,
     footer: {
@@ -50,7 +50,7 @@ module.exports = {
             {
               label: 'Contributing',
               to: 'docs/meta-contributing',
-            }
+            },
           ],
         },
         {
@@ -67,7 +67,7 @@ module.exports = {
             {
               label: 'Submit on issue on GitHub',
               href: 'https://github.com/wix/react-native-navigation/issues/new/choose',
-            }
+            },
           ],
         },
         {
@@ -83,7 +83,7 @@ module.exports = {
             },
           ],
         },
-      ]
+      ],
     },
   },
   presets: [
@@ -92,30 +92,14 @@ module.exports = {
       {
         docs: {
           sidebarPath: require.resolve('./sidebars.js'),
-          routeBasePath: 'docs',
+          routeBasePath: '/',
           path: 'docs',
-          editUrl:
-            'https://github.com/wix/react-native-navigation/edit/master/website'
+          editUrl: 'https://github.com/wix/react-native-navigation/edit/master/website',
         },
         theme: {
           customCss: require.resolve('./src/css/custom.css'),
         },
       },
     ],
-    [
-      '@docusaurus/preset-classic',
-      {
-        docs: {
-          routeBasePath: 'api',
-          path: 'api',
-          sidebarPath: require.resolve('./sidebarsApi.js'),
-          editUrl:
-            'https://github.com/wix/react-native-navigation/edit/master/website'
-        },
-        theme: {
-          customCss: require.resolve('./src/css/custom.css'),
-        },
-      },
-    ]
   ],
 };
diff --git a/website/sidebars.js b/website/sidebars.js
@@ -1,31 +1,74 @@
 module.exports = {
+  api: {
+    Navigation: ['api/component', 'api/root', 'api/stack', 'api/modal', 'api/overlay'],
+    Layouts: [
+      'api/layout-layout',
+      'api/layout-component',
+      'api/layout-stack',
+      'api/layout-bottomTabs',
+      'api/layout-sideMenu',
+      'api/layout-splitView',
+    ],
+    Options: [
+      'api/options-api',
+      'api/options-root',
+      'api/options-bottomTabs',
+      'api/options-bottomTab',
+      {
+        Stack: [
+          'api/options-stack',
+          'api/options-title',
+          'api/options-subtitle',
+          'api/options-background',
+          'api/options-backButton',
+          'api/options-button',
+          'api/options-iconInsets',
+          'api/options-largeTitle',
+        ],
+      },
+      'api/options-statusBar',
+      'api/options-layout',
+      'api/options-modal',
+      'api/options-navigationBar',
+      'api/options-overlay',
+      'api/options-sideMenu',
+      'api/options-sideMenuSide',
+      'api/options-splitView',
+    ],
+    Events: ['api/events'],
+  },
   docs: {
-    'Getting Started': ['before-you-start', 'installing', 'playground-app', 'showcases'],
+    'Getting Started': [
+      'docs/before-you-start',
+      'docs/installing',
+      'docs/playground-app',
+      'docs/showcases',
+    ],
     'Using the app': [
-      'app-launch',
-      'basic-navigation',
-      'advanced-navigation',
-      'screen-lifecycle',
-      'passing-data-to-components',
-      'functionalComponents',
+      'docs/app-launch',
+      'docs/basic-navigation',
+      'docs/advanced-navigation',
+      'docs/screen-lifecycle',
+      'docs/passing-data-to-components',
+      'docs/functionalComponents',
     ],
-    Layouts: ['stack', 'bottomTabs', 'sideMenu', 'externalComponent'],
-    Hierarchy: ['root', 'modal', 'overlay'],
+    Layouts: ['docs/stack', 'docs/bottomTabs', 'docs/sideMenu', 'docs/externalComponent'],
+    Hierarchy: ['docs/root', 'docs/modal', 'docs/overlay'],
     Styling: [
-      'style-options',
-      'style-theme',
-      'style-statusBar',
-      'style-orientation',
-      'style-animations',
-      'style-fonts',
-      'style-constants',
+      'docs/style-options',
+      'docs/style-theme',
+      'docs/style-statusBar',
+      'docs/style-orientation',
+      'docs/style-animations',
+      'docs/style-fonts',
+      'docs/style-constants',
     ],
     'Third party integration': [
-      'community-libraries',
-      'third-party-typescript',
-      'third-party-mobx',
-      'third-party-react-context',
+      'docs/community-libraries',
+      'docs/third-party-typescript',
+      'docs/third-party-mobx',
+      'docs/third-party-react-context',
     ],
-    Meta: ['meta-contributing'],
+    Meta: ['docs/meta-contributing'],
   },
 };
diff --git a/website/sidebarsApi.js b/website/sidebarsApi.js