@docusaurus/theme-classic 3.0.1 → 3.1.0

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-classic",
-  "version": "3.0.1",
+  "version": "3.1.0",
   "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.0",
+    "@docusaurus/mdx-loader": "3.1.0",
+    "@docusaurus/module-type-aliases": "3.1.0",
+    "@docusaurus/plugin-content-blog": "3.1.0",
+    "@docusaurus/plugin-content-docs": "3.1.0",
+    "@docusaurus/plugin-content-pages": "3.1.0",
+    "@docusaurus/theme-common": "3.1.0",
+    "@docusaurus/theme-translations": "3.1.0",
+    "@docusaurus/types": "3.1.0",
+    "@docusaurus/utils": "3.1.0",
+    "@docusaurus/utils-common": "3.1.0",
+    "@docusaurus/utils-validation": "3.1.0",
     "@mdx-js/react": "^3.0.0",
     "clsx": "^2.0.0",
     "copy-text-to-clipboard": "^3.2.0",
@@ -62,5 +62,5 @@
   "engines": {
     "node": ">=18.0"
   },
-  "gitHead": "29d816067fd0022d4ca3bd5fdc42098dac9f7ffc"
+  "gitHead": "a5e675821f0e8b70b591fcebf19fd60a70d55548"
 }

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-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;