@docusaurus/theme-classic 2.0.0-beta.1 → 2.0.0-beta.10

package/src/theme/IconEdit/index.tsx

@@ -12,7 +12,7 @@ import type {Props} from '@theme/IconEdit';
 
 import styles from './styles.module.css';
 
-const IconEdit = ({className, ...restProps}: Props): JSX.Element => {
+function IconEdit({className, ...restProps}: Props): JSX.Element {
   return (
     <svg
       fill="currentColor"
@@ -27,6 +27,6 @@ const IconEdit = ({className, ...restProps}: Props): JSX.Element => {
       </g>
     </svg>
   );
-};
+}
 
 export default IconEdit;

package/src/theme/IconExternalLink/index.tsx

@@ -10,10 +10,7 @@ import type {Props} from '@theme/IconExternalLink';
 
 import styles from './styles.module.css';
 
-const IconExternalLink = ({
-  width = 13.5,
-  height = 13.5,
-}: Props): JSX.Element => {
+function IconExternalLink({width = 13.5, height = 13.5}: Props): JSX.Element {
   return (
     <svg
       width={width}
@@ -27,6 +24,6 @@ const IconExternalLink = ({
       />
     </svg>
   );
-};
+}
 
 export default IconExternalLink;

package/src/theme/IconLanguage/index.tsx

@@ -8,11 +8,7 @@
 import React from 'react';
 import type {Props} from '@theme/IconLanguage';
 
-const IconLanguage = ({
-  width = 20,
-  height = 20,
-  ...props
-}: Props): JSX.Element => {
+function IconLanguage({width = 20, height = 20, ...props}: Props): JSX.Element {
   return (
     <svg
       viewBox="0 0 20 20"
@@ -26,6 +22,6 @@ const IconLanguage = ({
       />
     </svg>
   );
-};
+}
 
 export default IconLanguage;

package/src/theme/IconMenu/index.tsx

@@ -8,12 +8,12 @@
 import React from 'react';
 import type {Props} from '@theme/IconMenu';
 
-const IconMenu = ({
+function IconMenu({
   width = 30,
   height = 30,
   className,
   ...restProps
-}: Props): JSX.Element => {
+}: Props): JSX.Element {
   return (
     <svg
       className={className}
@@ -31,6 +31,6 @@ const IconMenu = ({
       />
     </svg>
   );
-};
+}
 
 export default IconMenu;

package/src/theme/LastUpdated/index.tsx

@@ -8,6 +8,7 @@
 import React from 'react';
 import Translate from '@docusaurus/Translate';
 import type {Props} from '@theme/LastUpdated';
+import {ThemeClassNames} from '@docusaurus/theme-common';
 
 function LastUpdatedAtDate({
   lastUpdatedAt,
@@ -57,7 +58,7 @@ export default function LastUpdated({
   lastUpdatedBy,
 }: Props): JSX.Element {
   return (
-    <>
+    <span className={ThemeClassNames.common.lastUpdated}>
       <Translate
         id="theme.lastUpdated.lastUpdatedAtBy"
         description="The sentence used to display when a page has been last updated, and by who"
@@ -84,6 +85,6 @@ export default function LastUpdated({
           <small> (Simulated during dev for better perf)</small>
         </div>
       )}
-    </>
+    </span>
   );
 }

package/src/theme/Layout/index.tsx

@@ -7,6 +7,7 @@
 
 import React from 'react';
 import clsx from 'clsx';
+import ErrorBoundary from '@docusaurus/ErrorBoundary';
 import SkipToContent from '@theme/SkipToContent';
 import AnnouncementBar from '@theme/AnnouncementBar';
 import Navbar from '@theme/Navbar';
@@ -16,6 +17,7 @@ import LayoutHead from '@theme/LayoutHead';
 import type {Props} from '@theme/Layout';
 import useKeyboardNavigation from '@theme/hooks/useKeyboardNavigation';
 import {ThemeClassNames} from '@docusaurus/theme-common';
+import ErrorPageContent from '@theme/ErrorPageContent';
 import './styles.css';
 
 function Layout(props: Props): JSX.Element {
@@ -39,7 +41,7 @@ function Layout(props: Props): JSX.Element {
           wrapperClassName,
           pageClassName,
         )}>
-        {children}
+        <ErrorBoundary fallback={ErrorPageContent}>{children}</ErrorBoundary>
       </div>
 
       {!noFooter && <Footer />}

package/src/theme/LayoutHead/index.tsx

@@ -10,12 +10,13 @@ import Head from '@docusaurus/Head';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import useBaseUrl from '@docusaurus/useBaseUrl';
 import type {Props} from '@theme/Layout';
-import SearchMetadatas from '@theme/SearchMetadatas';
+import SearchMetadata from '@theme/SearchMetadata';
 import Seo from '@theme/Seo';
 import {
   DEFAULT_SEARCH_TAG,
   useTitleFormatter,
   useAlternatePageUtils,
+  useThemeConfig,
 } from '@docusaurus/theme-common';
 import {useLocation} from '@docusaurus/router';
 
@@ -83,13 +84,11 @@ function CanonicalUrlHeaders({permalink}: {permalink?: string}) {
 
 export default function LayoutHead(props: Props): JSX.Element {
   const {
-    siteConfig: {
-      favicon,
-      themeConfig: {metadatas, image: defaultImage},
-    },
+    siteConfig: {favicon},
     i18n: {currentLocale, localeConfigs},
   } = useDocusaurusContext();
-  const {title, description, image, keywords, searchMetadatas} = props;
+  const {metadata, image: defaultImage} = useThemeConfig();
+  const {title, description, image, keywords, searchMetadata} = props;
   const faviconUrl = useBaseUrl(favicon);
   const pageTitle = useTitleFormatter(title);
 
@@ -102,36 +101,38 @@ export default function LayoutHead(props: Props): JSX.Element {
     <>
       <Head>
         <html lang={htmlLang} dir={htmlDir} />
-        {favicon && <link rel="shortcut icon" href={faviconUrl} />}
+        {favicon && <link rel="icon" href={faviconUrl} />}
         <title>{pageTitle}</title>
         <meta property="og:title" content={pageTitle} />
-        {image ||
-          (defaultImage && (
-            <meta name="twitter:card" content="summary_large_image" />
-          ))}
+        <meta name="twitter:card" content="summary_large_image" />
       </Head>
 
-      <Seo {...{description, keywords, image}} />
+      {/* image can override the default image */}
+      {defaultImage && <Seo image={defaultImage} />}
+      {image && <Seo image={image} />}
+
+      <Seo description={description} keywords={keywords} />
 
       <CanonicalUrlHeaders />
 
       <AlternateLangHeaders />
 
-      <SearchMetadatas
+      <SearchMetadata
         tag={DEFAULT_SEARCH_TAG}
         locale={currentLocale}
-        {...searchMetadatas}
+        {...searchMetadata}
       />
 
       <Head
       // it's important to have an additional <Head> element here,
       // as it allows react-helmet to override values set in previous <Head>
-      // ie we can override default metadatas such as "twitter:card"
+      // ie we can override default metadata such as "twitter:card"
       // In same Head, the same meta would appear twice instead of overriding
       // See react-helmet doc
       >
-        {metadatas.map((metadata, i) => (
-          <meta key={`metadata_${i}`} {...metadata} />
+        {/* Yes, "metadatum" is the grammatically correct term */}
+        {metadata.map((metadatum, i) => (
+          <meta key={`metadata_${i}`} {...metadatum} />
         ))}
       </Head>
     </>

package/src/theme/LayoutProviders/index.tsx

@@ -8,17 +8,28 @@
 import React from 'react';
 import ThemeProvider from '@theme/ThemeProvider';
 import UserPreferencesProvider from '@theme/UserPreferencesProvider';
-import {DocsPreferredVersionContextProvider} from '@docusaurus/theme-common';
+import {
+  AnnouncementBarProvider,
+  DocsPreferredVersionContextProvider,
+  MobileSecondaryMenuProvider,
+  ScrollControllerProvider,
+} from '@docusaurus/theme-common';
 import type {Props} from '@theme/LayoutProviders';
 
 export default function LayoutProviders({children}: Props): JSX.Element {
   return (
     <ThemeProvider>
-      <UserPreferencesProvider>
-        <DocsPreferredVersionContextProvider>
-          {children}
-        </DocsPreferredVersionContextProvider>
-      </UserPreferencesProvider>
+      <AnnouncementBarProvider>
+        <UserPreferencesProvider>
+          <ScrollControllerProvider>
+            <DocsPreferredVersionContextProvider>
+              <MobileSecondaryMenuProvider>
+                {children}
+              </MobileSecondaryMenuProvider>
+            </DocsPreferredVersionContextProvider>
+          </ScrollControllerProvider>
+        </UserPreferencesProvider>
+      </AnnouncementBarProvider>
     </ThemeProvider>
   );
 }

package/src/theme/Logo/index.tsx

@@ -12,17 +12,15 @@ import Link from '@docusaurus/Link';
 import ThemedImage from '@theme/ThemedImage';
 import useBaseUrl from '@docusaurus/useBaseUrl';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import {useThemeConfig} from '@docusaurus/theme-common';
 
-const Logo = (props: Props): JSX.Element => {
+function Logo(props: Props): JSX.Element {
   const {
-    siteConfig: {
-      title,
-      themeConfig: {
-        navbar: {title: navbarTitle, logo = {src: ''}},
-      },
-    },
-    isClient,
+    siteConfig: {title},
   } = useDocusaurusContext();
+  const {
+    navbar: {title: navbarTitle, logo = {src: ''}},
+  } = useThemeConfig();
 
   const {imageClassName, titleClassName, ...propsRest} = props;
   const logoLink = useBaseUrl(logo.href || '/');
@@ -30,23 +28,29 @@ const Logo = (props: Props): JSX.Element => {
     light: useBaseUrl(logo.src),
     dark: useBaseUrl(logo.srcDark || logo.src),
   };
+  const themedImage = (
+    <ThemedImage
+      sources={sources}
+      height={logo.height}
+      width={logo.width}
+      alt={logo.alt || navbarTitle || title}
+    />
+  );
 
   return (
     <Link
       to={logoLink}
       {...propsRest}
       {...(logo.target && {target: logo.target})}>
-      {logo.src && (
-        <ThemedImage
-          key={isClient}
-          className={imageClassName}
-          sources={sources}
-          alt={logo.alt || navbarTitle || title}
-        />
-      )}
+      {logo.src &&
+        (imageClassName ? (
+          <div className={imageClassName}>{themedImage}</div>
+        ) : (
+          themedImage
+        ))}
       {navbarTitle != null && <b className={titleClassName}>{navbarTitle}</b>}
     </Link>
   );
-};
+}
 
 export default Logo;

package/src/theme/MDXComponents/index.tsx

@@ -5,13 +5,33 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import React, {isValidElement} from 'react';
+import React, {ComponentProps, isValidElement, ReactElement} from 'react';
+import Head from '@docusaurus/Head';
 import Link from '@docusaurus/Link';
 import CodeBlock, {Props} from '@theme/CodeBlock';
 import Heading from '@theme/Heading';
+import Details from '@theme/Details';
 import type {MDXComponentsObject} from '@theme/MDXComponents';
 
+import './styles.css';
+
+// MDX elements are wrapped through the MDX pragma
+// In some cases (notably usage with Head/Helmet) we need to unwrap those elements.
+function unwrapMDXElement(element: ReactElement) {
+  if (element?.props?.mdxType && element?.props?.originalType) {
+    const {mdxType, originalType, ...newProps} = element.props;
+    return React.createElement(element.props.originalType, newProps);
+  }
+  return element;
+}
+
 const MDXComponents: MDXComponentsObject = {
+  head: (props) => {
+    const unwrappedChildren = React.Children.map(props.children, (child) =>
+      unwrapMDXElement(child as ReactElement),
+    );
+    return <Head {...props}>{unwrappedChildren}</Head>;
+  },
   code: (props) => {
     const {children} = props;
 
@@ -29,21 +49,35 @@ const MDXComponents: MDXComponentsObject = {
   },
   a: (props) => <Link {...props} />,
   pre: (props) => {
-    const {children} = props as {children: any};
+    const {children} = props;
 
     // See comment for `code` above
-    if (isValidElement(children?.props?.children)) {
-      return children?.props.children;
+    if (isValidElement(children) && isValidElement(children?.props?.children)) {
+      return children.props.children;
     }
 
     return (
       <CodeBlock
         {...((isValidElement(children)
           ? children?.props
-          : {children}) as Props)}
+          : {...props}) as Props)}
       />
     );
   },
+  details: (props): JSX.Element => {
+    const items = React.Children.toArray(props.children) as ReactElement[];
+    // Split summary item from the rest to pass it as a separate prop to the Detais theme component
+    const summary: ReactElement<ComponentProps<'summary'>> = items.find(
+      (item) => item?.props?.mdxType === 'summary',
+    )!;
+    const children = <>{items.filter((item) => item !== summary)}</>;
+
+    return (
+      <Details {...props} summary={summary}>
+        {children}
+      </Details>
+    );
+  },
   h1: Heading('h1'),
   h2: Heading('h2'),
   h3: Heading('h3'),

package/src/theme/MDXComponents/styles.css

@@ -0,0 +1,11 @@
+/**
+ * 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.
+ */
+
+ul.contains-task-list {
+  padding-left: 0;
+  list-style: none;
+}

package/src/theme/MDXPage/index.tsx

@@ -18,7 +18,11 @@ import styles from './styles.module.css';
 
 function MDXPage(props: Props): JSX.Element {
   const {content: MDXPageContent} = props;
-  const {frontMatter, metadata} = MDXPageContent;
+  const {
+    // TODO this frontmatter is not validated/normalized, it's the raw user-provided one. We should expose normalized one too!
+    frontMatter,
+    metadata,
+  } = MDXPageContent;
 
   const {
     title,
@@ -44,7 +48,11 @@ function MDXPage(props: Props): JSX.Element {
           </div>
           {!hideTableOfContents && MDXPageContent.toc && (
             <div className="col col--2">
-              <TOC toc={MDXPageContent.toc} />
+              <TOC
+                toc={MDXPageContent.toc}
+                minHeadingLevel={frontMatter.toc_min_heading_level}
+                maxHeadingLevel={frontMatter.toc_max_heading_level}
+              />
             </div>
           )}
         </div>