@docusaurus/theme-classic 3.0.1 → 3.1.1

package/lib/theme/CodeInline/index.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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.
+ */
+/// <reference types="react" />
+import type { Props } from '@theme/CodeInline';
+export default function CodeInline(props: Props): JSX.Element;

package/lib/theme/CodeInline/index.js

@@ -0,0 +1,13 @@
+/**
+ * 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 React from 'react';
+// Simple component used to render inline code blocks
+// its purpose is to be swizzled and customized
+// MDX 1 used to have a inlineCode comp, see https://mdxjs.com/migrating/v2/
+export default function CodeInline(props) {
+  return <code {...props} />;
+}

package/lib/theme/Heading/index.js

@@ -9,8 +9,10 @@ import clsx from 'clsx';
 import {translate} from '@docusaurus/Translate';
 import {useThemeConfig} from '@docusaurus/theme-common';
 import Link from '@docusaurus/Link';
+import useBrokenLinks from '@docusaurus/useBrokenLinks';
 import styles from './styles.module.css';
 export default function Heading({as: As, id, ...props}) {
+  const brokenLinks = useBrokenLinks();
   const {
     navbar: {hideOnScroll},
   } = useThemeConfig();
@@ -18,6 +20,7 @@ export default function Heading({as: As, id, ...props}) {
   if (As === 'h1' || !id) {
     return <As {...props} id={undefined} />;
   }
+  brokenLinks.collectAnchor(id);
   const anchorTitle = translate(
     {
       id: 'theme.common.headingLinkTitle',

package/lib/theme/MDXComponents/Code.js

@@ -6,9 +6,21 @@
  */
 import React from 'react';
 import CodeBlock from '@theme/CodeBlock';
+import CodeInline from '@theme/CodeInline';
+function shouldBeInline(props) {
+  return (
+    // empty code blocks have no props.children,
+    // see https://github.com/facebook/docusaurus/pull/9704
+    typeof props.children !== 'undefined' &&
+    React.Children.toArray(props.children).every(
+      (el) => typeof el === 'string' && !el.includes('\n'),
+    )
+  );
+}
 export default function MDXCode(props) {
-  const shouldBeInline = React.Children.toArray(props.children).every(
-    (el) => typeof el === 'string' && !el.includes('\n'),
+  return shouldBeInline(props) ? (
+    <CodeInline {...props} />
+  ) : (
+    <CodeBlock {...props} />
   );
-  return shouldBeInline ? <code {...props} /> : <CodeBlock {...props} />;
 }

package/lib/theme/MDXComponents/Img/index.js

@@ -14,6 +14,7 @@ export default function MDXImg(props) {
   return (
     // eslint-disable-next-line jsx-a11y/alt-text
     <img
+      decoding="async"
       loading="lazy"
       {...props}
       className={transformImgClassName(props.className)}

package/lib/theme/MDXComponents/Li.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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 ReactNode } from 'react';
+import type { Props } from '@theme/MDXComponents/Li';
+export default function MDXLi(props: Props): ReactNode | undefined;

package/lib/theme/MDXComponents/Li.js

@@ -0,0 +1,13 @@
+/**
+ * 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 React from 'react';
+import useBrokenLinks from '@docusaurus/useBrokenLinks';
+export default function MDXLi(props) {
+  // MDX Footnotes have ids such as <li id="user-content-fn-1-953011">
+  useBrokenLinks().collectAnchor(props.id);
+  return <li {...props} />;
+}

package/lib/theme/MDXComponents/index.js

@@ -12,6 +12,7 @@ import MDXPre from '@theme/MDXComponents/Pre';
 import MDXDetails from '@theme/MDXComponents/Details';
 import MDXHeading from '@theme/MDXComponents/Heading';
 import MDXUl from '@theme/MDXComponents/Ul';
+import MDXLi from '@theme/MDXComponents/Li';
 import MDXImg from '@theme/MDXComponents/Img';
 import Admonition from '@theme/Admonition';
 import Mermaid from '@theme/Mermaid';
@@ -23,6 +24,7 @@ const MDXComponents = {
   a: MDXA,
   pre: MDXPre,
   ul: MDXUl,
+  li: MDXLi,
   img: MDXImg,
   h1: (props) => <MDXHeading as="h1" {...props} />,
   h2: (props) => <MDXHeading as="h2" {...props} />,

package/lib/theme/NavbarItem/DropdownNavbarItem/index.js

@@ -66,6 +66,9 @@ function DropdownNavbarItemDesktop({
         aria-haspopup="true"
         aria-expanded={showDropdown}
         role="button"
+        // # hash permits to make the <a> tag focusable in case no link target
+        // See https://github.com/facebook/docusaurus/pull/6003
+        // There's probably a better solution though...
         href={props.to ? undefined : '#'}
         className={clsx('navbar__link', className)}
         {...props}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-classic",
-  "version": "3.0.1",
+  "version": "3.1.1",
   "description": "Classic theme for Docusaurus",
   "main": "lib/index.js",
   "types": "src/theme-classic.d.ts",
@@ -20,18 +20,18 @@
     "copy:watch": "node ../../admin/scripts/copyUntypedFiles.js --watch"
   },
   "dependencies": {
-    "@docusaurus/core": "3.0.1",
-    "@docusaurus/mdx-loader": "3.0.1",
-    "@docusaurus/module-type-aliases": "3.0.1",
-    "@docusaurus/plugin-content-blog": "3.0.1",
-    "@docusaurus/plugin-content-docs": "3.0.1",
-    "@docusaurus/plugin-content-pages": "3.0.1",
-    "@docusaurus/theme-common": "3.0.1",
-    "@docusaurus/theme-translations": "3.0.1",
-    "@docusaurus/types": "3.0.1",
-    "@docusaurus/utils": "3.0.1",
-    "@docusaurus/utils-common": "3.0.1",
-    "@docusaurus/utils-validation": "3.0.1",
+    "@docusaurus/core": "3.1.1",
+    "@docusaurus/mdx-loader": "3.1.1",
+    "@docusaurus/module-type-aliases": "3.1.1",
+    "@docusaurus/plugin-content-blog": "3.1.1",
+    "@docusaurus/plugin-content-docs": "3.1.1",
+    "@docusaurus/plugin-content-pages": "3.1.1",
+    "@docusaurus/theme-common": "3.1.1",
+    "@docusaurus/theme-translations": "3.1.1",
+    "@docusaurus/types": "3.1.1",
+    "@docusaurus/utils": "3.1.1",
+    "@docusaurus/utils-common": "3.1.1",
+    "@docusaurus/utils-validation": "3.1.1",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",
     "copy-text-to-clipboard": "^3.2.0",
@@ -47,7 +47,6 @@
     "utility-types": "^3.10.0"
   },
   "devDependencies": {
-    "@types/mdx-js__react": "^1.5.5",
     "@types/nprogress": "^0.2.0",
     "@types/prismjs": "^1.26.0",
     "@types/rtlcss": "^3.5.1",
@@ -62,5 +61,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "29d816067fd0022d4ca3bd5fdc42098dac9f7ffc"
+  "gitHead": "8017f6a6776ba1bd7065e630a52fe2c2654e2f1b"
 }

package/src/theme/CodeInline/index.tsx

@@ -0,0 +1,16 @@
+/**
+ * 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 React from 'react';
+import type {Props} from '@theme/CodeInline';
+
+// Simple component used to render inline code blocks
+// its purpose is to be swizzled and customized
+// MDX 1 used to have a inlineCode comp, see https://mdxjs.com/migrating/v2/
+export default function CodeInline(props: Props): JSX.Element {
+  return <code {...props} />;
+}

package/src/theme/Heading/index.tsx

@@ -10,11 +10,13 @@ import clsx from 'clsx';
 import {translate} from '@docusaurus/Translate';
 import {useThemeConfig} from '@docusaurus/theme-common';
 import Link from '@docusaurus/Link';
+import useBrokenLinks from '@docusaurus/useBrokenLinks';
 import type {Props} from '@theme/Heading';
 
 import styles from './styles.module.css';
 
 export default function Heading({as: As, id, ...props}: Props): JSX.Element {
+  const brokenLinks = useBrokenLinks();
   const {
     navbar: {hideOnScroll},
   } = useThemeConfig();
@@ -23,6 +25,8 @@ export default function Heading({as: As, id, ...props}: Props): JSX.Element {
     return <As {...props} id={undefined} />;
   }
 
+  brokenLinks.collectAnchor(id);
+
   const anchorTitle = translate(
     {
       id: 'theme.common.headingLinkTitle',

package/src/theme/MDXComponents/Code.tsx

@@ -8,15 +8,23 @@
 import type {ComponentProps} from 'react';
 import React from 'react';
 import CodeBlock from '@theme/CodeBlock';
+import CodeInline from '@theme/CodeInline';
 import type {Props} from '@theme/MDXComponents/Code';
 
-export default function MDXCode(props: Props): JSX.Element {
-  const shouldBeInline = React.Children.toArray(props.children).every(
-    (el) => typeof el === 'string' && !el.includes('\n'),
+function shouldBeInline(props: Props) {
+  return (
+    // empty code blocks have no props.children,
+    // see https://github.com/facebook/docusaurus/pull/9704
+    typeof props.children !== 'undefined' &&
+    React.Children.toArray(props.children).every(
+      (el) => typeof el === 'string' && !el.includes('\n'),
+    )
   );
+}
 
-  return shouldBeInline ? (
-    <code {...props} />
+export default function MDXCode(props: Props): JSX.Element {
+  return shouldBeInline(props) ? (
+    <CodeInline {...props} />
   ) : (
     <CodeBlock {...(props as ComponentProps<typeof CodeBlock>)} />
   );

package/src/theme/MDXComponents/Img/index.tsx

@@ -19,6 +19,7 @@ export default function MDXImg(props: Props): JSX.Element {
   return (
     // eslint-disable-next-line jsx-a11y/alt-text
     <img
+      decoding="async"
       loading="lazy"
       {...props}
       className={transformImgClassName(props.className)}

package/src/theme/MDXComponents/Li.tsx

@@ -0,0 +1,17 @@
+/**
+ * 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 React, {type ReactNode} from 'react';
+import useBrokenLinks from '@docusaurus/useBrokenLinks';
+import type {Props} from '@theme/MDXComponents/Li';
+
+export default function MDXLi(props: Props): ReactNode | undefined {
+  // MDX Footnotes have ids such as <li id="user-content-fn-1-953011">
+  useBrokenLinks().collectAnchor(props.id);
+
+  return <li {...props} />;
+}

package/src/theme/MDXComponents/index.tsx

@@ -13,6 +13,7 @@ import MDXPre from '@theme/MDXComponents/Pre';
 import MDXDetails from '@theme/MDXComponents/Details';
 import MDXHeading from '@theme/MDXComponents/Heading';
 import MDXUl from '@theme/MDXComponents/Ul';
+import MDXLi from '@theme/MDXComponents/Li';
 import MDXImg from '@theme/MDXComponents/Img';
 import Admonition from '@theme/Admonition';
 import Mermaid from '@theme/Mermaid';
@@ -27,6 +28,7 @@ const MDXComponents: MDXComponentsObject = {
   a: MDXA,
   pre: MDXPre,
   ul: MDXUl,
+  li: MDXLi,
   img: MDXImg,
   h1: (props: ComponentProps<'h1'>) => <MDXHeading as="h1" {...props} />,
   h2: (props: ComponentProps<'h2'>) => <MDXHeading as="h2" {...props} />,

package/src/theme/NavbarItem/DropdownNavbarItem/index.tsx

@@ -89,6 +89,9 @@ function DropdownNavbarItemDesktop({
         aria-haspopup="true"
         aria-expanded={showDropdown}
         role="button"
+        // # hash permits to make the <a> tag focusable in case no link target
+        // See https://github.com/facebook/docusaurus/pull/6003
+        // There's probably a better solution though...
         href={props.to ? undefined : '#'}
         className={clsx('navbar__link', className)}
         {...props}

package/src/theme-classic.d.ts

@@ -363,6 +363,14 @@ declare module '@theme/CodeBlock' {
   export default function CodeBlock(props: Props): JSX.Element;
 }
 
+declare module '@theme/CodeInline' {
+  import type {ComponentProps} from 'react';
+
+  export interface Props extends ComponentProps<'code'> {}
+
+  export default function CodeInline(props: Props): JSX.Element;
+}
+
 declare module '@theme/CodeBlock/CopyButton' {
   export interface Props {
     readonly code: string;
@@ -859,6 +867,14 @@ declare module '@theme/MDXComponents/Ul' {
   export default function MDXUl(props: Props): JSX.Element;
 }
 
+declare module '@theme/MDXComponents/Li' {
+  import type {ComponentProps} from 'react';
+
+  export interface Props extends ComponentProps<'li'> {}
+
+  export default function MDXLi(props: Props): JSX.Element;
+}
+
 declare module '@theme/MDXComponents/Img' {
   import type {ComponentProps} from 'react';