@docusaurus/theme-classic 0.0.0-4859 → 0.0.0-4864

package/lib/theme-classic.d.ts

@@ -156,6 +156,7 @@ declare module '@theme/CodeBlock' {
     readonly metastring?: string;
     readonly title?: string;
     readonly language?: string;
+    readonly showLineNumbers?: boolean;
   }
 
   export default function CodeBlock(props: Props): JSX.Element;
@@ -795,7 +796,9 @@ declare module '@theme/NavbarItem/DocNavbarItem' {
     readonly docsPluginId?: string;
   }
 
-  export default function DocsSidebarNavbarItem(props: Props): JSX.Element;
+  export default function DocsSidebarNavbarItem(
+    props: Props,
+  ): JSX.Element | null;
 }
 
 declare module '@theme/NavbarItem/DocSidebarNavbarItem' {

package/lib-next/theme/CodeBlock/index.js

@@ -12,6 +12,7 @@ import {
   parseCodeBlockTitle,
   parseLanguage,
   parseLines,
+  containsLineNumbers,
   ThemeClassNames,
   usePrismTheme,
 } from '@docusaurus/theme-common';
@@ -22,6 +23,7 @@ export default function CodeBlock({
   className: blockClassName = '',
   metastring,
   title,
+  showLineNumbers,
   language: languageProp,
 }) {
   const {prism} = useThemeConfig();
@@ -76,6 +78,8 @@ export default function CodeBlock({
   const language =
     languageProp ?? parseLanguage(blockClassName) ?? prism.defaultLanguage;
   const {highlightLines, code} = parseLines(content, metastring, language);
+  const shouldShowLineNumbers =
+    showLineNumbers || containsLineNumbers(metastring);
   return (
     <Highlight
       {...defaultProps}
@@ -104,7 +108,11 @@ export default function CodeBlock({
               /* eslint-disable-next-line jsx-a11y/no-noninteractive-tabindex */
               tabIndex={0}
               className={clsx(className, styles.codeBlock, 'thin-scrollbar')}>
-              <code className={styles.codeBlockLines}>
+              <code
+                className={clsx(
+                  styles.codeBlockLines,
+                  shouldShowLineNumbers && styles.codeBlockLinesWithNumbering,
+                )}>
                 {tokens.map((line, i) => {
                   if (line.length === 1 && line[0].content === '\n') {
                     line[0].content = '';
@@ -113,24 +121,39 @@ export default function CodeBlock({
                   const lineProps = getLineProps({
                     line,
                     key: i,
+                    ...(shouldShowLineNumbers && {
+                      className: styles.codeLine,
+                    }),
                   });
 
                   if (highlightLines.includes(i)) {
                     lineProps.className += ' docusaurus-highlight-code-line';
                   }
 
+                  const lineTokens = line.map((token, key) => (
+                    <span
+                      key={key}
+                      {...getTokenProps({
+                        token,
+                        key,
+                      })}
+                    />
+                  ));
                   return (
                     <span key={i} {...lineProps}>
-                      {line.map((token, key) => (
-                        <span
-                          key={key}
-                          {...getTokenProps({
-                            token,
-                            key,
-                          })}
-                        />
-                      ))}
-                      <br />
+                      {shouldShowLineNumbers ? (
+                        <>
+                          <span className={styles.codeLineNumber} />
+                          <span className={styles.codeLineContent}>
+                            {lineTokens}
+                          </span>
+                        </>
+                      ) : (
+                        <>
+                          {lineTokens}
+                          <br />
+                        </>
+                      )}
                     </span>
                   );
                 })}

package/lib-next/theme/CodeBlock/styles.module.css

@@ -28,9 +28,9 @@
 }
 
 .codeBlock {
+  --ifm-pre-background: inherit;
   margin: 0;
   padding: 0;
-  background-color: inherit;
 }
 
 .codeBlockTitle + .codeBlockContent .codeBlock {
@@ -44,14 +44,48 @@
 
 .codeBlockLines {
   font: inherit;
+  background: var(--ifm-pre-background);
   /* rtl:ignore */
   float: left;
   min-width: 100%;
   padding: var(--ifm-pre-padding);
 }
 
+.codeBlockLinesWithNumbering {
+  display: table;
+  padding: var(--ifm-pre-padding) 0;
+}
+
 @media print {
   .codeBlockLines {
     white-space: pre-wrap;
   }
 }
+
+.codeLine {
+  display: table-row;
+  counter-increment: line-count;
+}
+
+.codeLineNumber {
+  display: table-cell;
+  text-align: right;
+  width: 1%;
+  position: sticky;
+  left: 0;
+  padding: 0 var(--ifm-pre-padding);
+  background: var(--ifm-pre-background);
+}
+
+.codeLineNumber::before {
+  content: counter(line-count);
+  opacity: 0.4;
+}
+
+:global(.docusaurus-highlight-code-line) .codeLineNumber::before {
+  opacity: 0.8;
+}
+
+.codeLineContent {
+  padding-right: var(--ifm-pre-padding);
+}

package/lib-next/theme/NavbarItem/DocNavbarItem.js

@@ -17,7 +17,12 @@ export default function DocNavbarItem({
   ...props
 }) {
   const {activeDoc} = useActiveDocContext(docsPluginId);
-  const doc = useLayoutDoc(docId, docsPluginId);
+  const doc = useLayoutDoc(docId, docsPluginId); // Draft items are not displayed in the navbar.
+
+  if (doc === null) {
+    return null;
+  }
+
   const activeDocInfimaClassName = getInfimaActiveClassName(props.mobile);
   return (
     <DefaultNavbarItem

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/theme-classic",
-  "version": "0.0.0-4859",
+  "version": "0.0.0-4864",
   "description": "Classic theme for Docusaurus",
   "main": "lib/index.js",
   "types": "src/theme-classic.d.ts",
@@ -21,15 +21,15 @@
     "format:lib-next": "prettier --config ../../.prettierrc --write \"lib-next/**/*.{js,ts,jsx,tsc}\""
   },
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4859",
-    "@docusaurus/plugin-content-blog": "0.0.0-4859",
-    "@docusaurus/plugin-content-docs": "0.0.0-4859",
-    "@docusaurus/plugin-content-pages": "0.0.0-4859",
-    "@docusaurus/theme-common": "0.0.0-4859",
-    "@docusaurus/theme-translations": "0.0.0-4859",
-    "@docusaurus/utils": "0.0.0-4859",
-    "@docusaurus/utils-common": "0.0.0-4859",
-    "@docusaurus/utils-validation": "0.0.0-4859",
+    "@docusaurus/core": "0.0.0-4864",
+    "@docusaurus/plugin-content-blog": "0.0.0-4864",
+    "@docusaurus/plugin-content-docs": "0.0.0-4864",
+    "@docusaurus/plugin-content-pages": "0.0.0-4864",
+    "@docusaurus/theme-common": "0.0.0-4864",
+    "@docusaurus/theme-translations": "0.0.0-4864",
+    "@docusaurus/utils": "0.0.0-4864",
+    "@docusaurus/utils-common": "0.0.0-4864",
+    "@docusaurus/utils-validation": "0.0.0-4864",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.1.1",
     "copy-text-to-clipboard": "^3.0.1",
@@ -45,8 +45,8 @@
     "@babel/cli": "^7.17.6",
     "@babel/core": "^7.17.9",
     "@babel/preset-typescript": "^7.16.7",
-    "@docusaurus/module-type-aliases": "0.0.0-4859",
-    "@docusaurus/types": "0.0.0-4859",
+    "@docusaurus/module-type-aliases": "0.0.0-4864",
+    "@docusaurus/types": "0.0.0-4864",
     "@types/mdx-js__react": "^1.5.5",
     "@types/prismjs": "^1.26.0",
     "@types/rtlcss": "^3.1.3",
@@ -62,5 +62,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "2c2a2a24c95862a8d08be5ca1a1f7ff57d41c166"
+  "gitHead": "ae6d7c8caecd661cd85ab05c9d7e9ecd935725a1"
 }

package/src/theme/CodeBlock/index.tsx

@@ -13,6 +13,7 @@ import {
   parseCodeBlockTitle,
   parseLanguage,
   parseLines,
+  containsLineNumbers,
   ThemeClassNames,
   usePrismTheme,
 } from '@docusaurus/theme-common';
@@ -26,6 +27,7 @@ export default function CodeBlock({
   className: blockClassName = '',
   metastring,
   title,
+  showLineNumbers,
   language: languageProp,
 }: Props): JSX.Element {
   const {prism} = useThemeConfig();
@@ -87,6 +89,8 @@ export default function CodeBlock({
   const language =
     languageProp ?? parseLanguage(blockClassName) ?? prism.defaultLanguage;
   const {highlightLines, code} = parseLines(content, metastring, language);
+  const shouldShowLineNumbers =
+    showLineNumbers || containsLineNumbers(metastring);
 
   return (
     <Highlight
@@ -116,24 +120,45 @@ export default function CodeBlock({
               /* eslint-disable-next-line jsx-a11y/no-noninteractive-tabindex */
               tabIndex={0}
               className={clsx(className, styles.codeBlock, 'thin-scrollbar')}>
-              <code className={styles.codeBlockLines}>
+              <code
+                className={clsx(
+                  styles.codeBlockLines,
+                  shouldShowLineNumbers && styles.codeBlockLinesWithNumbering,
+                )}>
                 {tokens.map((line, i) => {
                   if (line.length === 1 && line[0]!.content === '\n') {
                     line[0]!.content = '';
                   }
 
-                  const lineProps = getLineProps({line, key: i});
+                  const lineProps = getLineProps({
+                    line,
+                    key: i,
+                    ...(shouldShowLineNumbers && {className: styles.codeLine}),
+                  });
 
                   if (highlightLines.includes(i)) {
                     lineProps.className += ' docusaurus-highlight-code-line';
                   }
 
+                  const lineTokens = line.map((token, key) => (
+                    <span key={key} {...getTokenProps({token, key})} />
+                  ));
+
                   return (
                     <span key={i} {...lineProps}>
-                      {line.map((token, key) => (
-                        <span key={key} {...getTokenProps({token, key})} />
-                      ))}
-                      <br />
+                      {shouldShowLineNumbers ? (
+                        <>
+                          <span className={styles.codeLineNumber} />
+                          <span className={styles.codeLineContent}>
+                            {lineTokens}
+                          </span>
+                        </>
+                      ) : (
+                        <>
+                          {lineTokens}
+                          <br />
+                        </>
+                      )}
                     </span>
                   );
                 })}

package/src/theme/CodeBlock/styles.module.css

@@ -28,9 +28,9 @@
 }
 
 .codeBlock {
+  --ifm-pre-background: inherit;
   margin: 0;
   padding: 0;
-  background-color: inherit;
 }
 
 .codeBlockTitle + .codeBlockContent .codeBlock {
@@ -44,14 +44,48 @@
 
 .codeBlockLines {
   font: inherit;
+  background: var(--ifm-pre-background);
   /* rtl:ignore */
   float: left;
   min-width: 100%;
   padding: var(--ifm-pre-padding);
 }
 
+.codeBlockLinesWithNumbering {
+  display: table;
+  padding: var(--ifm-pre-padding) 0;
+}
+
 @media print {
   .codeBlockLines {
     white-space: pre-wrap;
   }
 }
+
+.codeLine {
+  display: table-row;
+  counter-increment: line-count;
+}
+
+.codeLineNumber {
+  display: table-cell;
+  text-align: right;
+  width: 1%;
+  position: sticky;
+  left: 0;
+  padding: 0 var(--ifm-pre-padding);
+  background: var(--ifm-pre-background);
+}
+
+.codeLineNumber::before {
+  content: counter(line-count);
+  opacity: 0.4;
+}
+
+:global(.docusaurus-highlight-code-line) .codeLineNumber::before {
+  opacity: 0.8;
+}
+
+.codeLineContent {
+  padding-right: var(--ifm-pre-padding);
+}

package/src/theme/NavbarItem/DocNavbarItem.tsx

@@ -18,9 +18,15 @@ export default function DocNavbarItem({
   label: staticLabel,
   docsPluginId,
   ...props
-}: Props): JSX.Element {
+}: Props): JSX.Element | null {
   const {activeDoc} = useActiveDocContext(docsPluginId);
   const doc = useLayoutDoc(docId, docsPluginId);
+
+  // Draft items are not displayed in the navbar.
+  if (doc === null) {
+    return null;
+  }
+
   const activeDocInfimaClassName = getInfimaActiveClassName(props.mobile);
 
   return (

package/src/theme-classic.d.ts

@@ -156,6 +156,7 @@ declare module '@theme/CodeBlock' {
     readonly metastring?: string;
     readonly title?: string;
     readonly language?: string;
+    readonly showLineNumbers?: boolean;
   }
 
   export default function CodeBlock(props: Props): JSX.Element;
@@ -795,7 +796,9 @@ declare module '@theme/NavbarItem/DocNavbarItem' {
     readonly docsPluginId?: string;
   }
 
-  export default function DocsSidebarNavbarItem(props: Props): JSX.Element;
+  export default function DocsSidebarNavbarItem(
+    props: Props,
+  ): JSX.Element | null;
 }
 
 declare module '@theme/NavbarItem/DocSidebarNavbarItem' {