@docusaurus/theme-classic 2.0.0-beta.20 → 2.0.0-beta.21

package/lib/getSwizzleConfig.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { SwizzleConfig } from '@docusaurus/types';
+export default function getSwizzleConfig(): SwizzleConfig;

package/lib/getSwizzleConfig.js

@@ -1,243 +1,228 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = getSwizzleConfig;
-
 /**
  * Copyright (c) Facebook, Inc. and its affiliates.
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-
+Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint sort-keys: "error" */
 function getSwizzleConfig() {
-  return {
-    components: {
-      CodeBlock: {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The component used to render multi-line code blocks, generally used in Markdown files.'
-      },
-      ColorModeToggle: {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The color mode toggle to switch between light and dark mode.'
-      },
-      DocSidebar: {
-        actions: {
-          eject: 'unsafe',
-          // Too much technical code in sidebar, not very safe atm
-          wrap: 'safe'
-        },
-        description: 'The sidebar component on docs pages'
-      },
-      Footer: {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: "The footer component of you site's layout"
-      },
-      'Footer/Copyright': {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The footer copyright'
-      },
-      'Footer/Layout': {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The footer main layout component'
-      },
-      'Footer/LinkItem': {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The footer link item component'
-      },
-      'Footer/Links': {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The footer component rendering the footer links'
-      },
-      'Footer/Links/MultiColumn': {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The footer component rendering the footer links with a multi-column layout'
-      },
-      'Footer/Links/Simple': {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The footer component rendering the footer links with a simple layout (single row)'
-      },
-      'Footer/Logo': {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The footer logo'
-      },
-      IconArrow: {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The arrow icon component'
-      },
-      IconDarkMode: {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The dark mode icon component.'
-      },
-      IconEdit: {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The edit icon component'
-      },
-      IconLightMode: {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The light mode icon component.'
-      },
-      IconMenu: {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The menu icon component'
-      },
-      MDXComponents: {
-        actions: {
-          eject: 'safe',
-          wrap: 'forbidden' /// TODO allow wrapping objects???
-
-        },
-        description: 'The MDX components to use for rendering MDX files. Meant to be ejected.'
-      },
-      'MDXComponents/A': {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The component used to render <a> tags and Markdown links in MDX'
-      },
-      'MDXComponents/Code': {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The component used to render <code> tags and Markdown code blocks in MDX'
-      },
-      'MDXComponents/Details': {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The component used to render <details> tags in MDX'
-      },
-      'MDXComponents/Head': {
-        actions: {
-          eject: 'forbidden',
-          wrap: 'forbidden'
-        },
-        description: 'Technical component used to assign metadata (generally for SEO purpose) to the current MDX document'
-      },
-      'MDXComponents/Heading': {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The component used to render heading tags (<h1>, <h2>...) and Markdown headings in MDX'
-      },
-      'MDXComponents/Img': {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The component used to render <img> tags and Markdown images in MDX'
-      },
-      'MDXComponents/Pre': {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The component used to render <pre> tags in MDX'
-      },
-      'MDXComponents/Ul': {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The component used to render <ul> tags and Markdown unordered lists in MDX'
-      },
-      MDXContent: {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'A component wrapping all MDX content and providing the MDXComponents to the MDX context'
-      },
-      'NavbarItem/ComponentTypes': {
-        actions: {
-          eject: 'safe',
-          wrap: 'forbidden'
-        },
-        description: 'The Navbar item components mapping. Can be ejected to add custom navbar item types. See https://github.com/facebook/docusaurus/issues/7227.'
-      },
-      // TODO should probably not even appear here
-      'NavbarItem/utils': {
-        actions: {
-          eject: 'forbidden',
-          wrap: 'forbidden'
-        }
-      },
-      NotFound: {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        description: 'The global 404 page of your site, meant to be ejected and customized'
-      },
-      SearchBar: {
-        actions: {
-          eject: 'safe',
-          wrap: 'safe'
-        },
-        // TODO how to describe this one properly?
-        // By default it's an empty placeholder for the user to fill
-        description: 'The search bar component of your site, appearing in the navbar.'
-      },
-      'prism-include-languages': {
-        actions: {
-          eject: 'safe',
-          wrap: 'forbidden' // Not a component!
-
-        },
-        description: 'The Prism languages to include for code block syntax highlighting. Meant to be ejected.'
-      }
-    }
-  };
-}
+    return {
+        components: {
+            CodeBlock: {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The component used to render multi-line code blocks, generally used in Markdown files.',
+            },
+            ColorModeToggle: {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The color mode toggle to switch between light and dark mode.',
+            },
+            DocSidebar: {
+                actions: {
+                    eject: 'unsafe',
+                    wrap: 'safe',
+                },
+                description: 'The sidebar component on docs pages',
+            },
+            Footer: {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: "The footer component of you site's layout",
+            },
+            'Footer/Copyright': {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The footer copyright',
+            },
+            'Footer/Layout': {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The footer main layout component',
+            },
+            'Footer/LinkItem': {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The footer link item component',
+            },
+            'Footer/Links': {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The footer component rendering the footer links',
+            },
+            'Footer/Links/MultiColumn': {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The footer component rendering the footer links with a multi-column layout',
+            },
+            'Footer/Links/Simple': {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The footer component rendering the footer links with a simple layout (single row)',
+            },
+            'Footer/Logo': {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The footer logo',
+            },
+            IconArrow: {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The arrow icon component',
+            },
+            IconDarkMode: {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The dark mode icon component.',
+            },
+            IconEdit: {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The edit icon component',
+            },
+            IconLightMode: {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The light mode icon component.',
+            },
+            IconMenu: {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The menu icon component',
+            },
+            MDXComponents: {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'forbidden', /// TODO allow wrapping objects???
+                },
+                description: 'The MDX components to use for rendering MDX files. Meant to be ejected.',
+            },
+            'MDXComponents/A': {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The component used to render <a> tags and Markdown links in MDX',
+            },
+            'MDXComponents/Code': {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The component used to render <code> tags and Markdown code blocks in MDX',
+            },
+            'MDXComponents/Details': {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The component used to render <details> tags in MDX',
+            },
+            'MDXComponents/Head': {
+                actions: {
+                    eject: 'forbidden',
+                    wrap: 'forbidden',
+                },
+                description: 'Technical component used to assign metadata (generally for SEO purpose) to the current MDX document',
+            },
+            'MDXComponents/Heading': {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The component used to render heading tags (<h1>, <h2>...) and Markdown headings in MDX',
+            },
+            'MDXComponents/Img': {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The component used to render <img> tags and Markdown images in MDX',
+            },
+            'MDXComponents/Pre': {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The component used to render <pre> tags in MDX',
+            },
+            'MDXComponents/Ul': {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The component used to render <ul> tags and Markdown unordered lists in MDX',
+            },
+            MDXContent: {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'A component wrapping all MDX content and providing the MDXComponents to the MDX context',
+            },
+            'NavbarItem/ComponentTypes': {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'forbidden',
+                },
+                description: 'The Navbar item components mapping. Can be ejected to add custom navbar item types. See https://github.com/facebook/docusaurus/issues/7227.',
+            },
+            NotFound: {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                description: 'The global 404 page of your site, meant to be ejected and customized',
+            },
+            SearchBar: {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'safe',
+                },
+                // TODO how to describe this one properly?
+                // By default it's an empty placeholder for the user to fill
+                description: 'The search bar component of your site, appearing in the navbar.',
+            },
+            'prism-include-languages': {
+                actions: {
+                    eject: 'safe',
+                    wrap: 'forbidden', // Not a component!
+                },
+                description: 'The Prism languages to include for code block syntax highlighting. Meant to be ejected.',
+            },
+        },
+    };
+}
+exports.default = getSwizzleConfig;

package/lib/index.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { LoadContext, Plugin } from '@docusaurus/types';
+import type { Options } from '@docusaurus/theme-classic';
+export declare const AnnouncementBarDismissStorageKey = "docusaurus.announcement.dismiss";
+export default function themeClassic(context: LoadContext, options: Options): Plugin<undefined>;
+export { default as getSwizzleConfig } from './getSwizzleConfig';
+export { validateThemeConfig } from './validateThemeConfig';