Attempt to use TS sidebar

facebook · Oct 12, 2023 · 6932057 · 6932057
1 parent b9a12d3
commit 6932057
Show file tree

Hide file tree

Showing 10 changed files with 20 additions and 14 deletions.
diff --git a/packages/docusaurus-plugin-content-docs/src/sidebars/index.ts b/packages/docusaurus-plugin-content-docs/src/sidebars/index.ts
@@ -89,9 +89,16 @@ export async function loadSidebarsFileUnsafe(
   }
 
   // We don't want sidebars to be cached because of hot reloading.
-  return jiti(__filename, {
+  const sidebars = jiti(__filename, {
     cache: false,
+    interopDefault: true,
+    debug: true,
   })(sidebarFilePath);
+
+  sidebarFilePath.endsWith('.ts') &&
+    console.log({sidebarFilePath}, JSON.stringify(sidebars, null, 2));
+
+  return sidebars;
 }
 
 export async function loadSidebars(

diff --git a/website/docs/guides/docs/sidebar/index.mdx b/website/docs/guides/docs/sidebar/index.mdx
@@ -201,7 +201,7 @@ A real-world example from the Docusaurus site:
 import CodeBlock from '@theme/CodeBlock';
 
 <CodeBlock language="js" title="sidebars.js">
-  {require('!!raw-loader!@site/sidebars.js')
+  {require('!!raw-loader!@site/sidebars.ts')
     .default
     .split('\n')
     // remove comments

diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -365,7 +365,7 @@ module.exports = async function createConfigAsync() {
           docs: {
             // routeBasePath: '/',
             path: 'docs',
-            sidebarPath: 'sidebars.js',
+            sidebarPath: 'sidebars.ts',
             // sidebarCollapsible: false,
             // sidebarCollapsed: true,
             editUrl: ({locale, docPath}) => {

diff --git a/website/sidebars.js → website/sidebars.ts b/website/sidebars.js → website/sidebars.ts
@@ -5,10 +5,9 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-// @ts-check
+import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
 
-/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
-const sidebars = {
+const sidebars: SidebarsConfig = {
   docs: [
     'introduction',
     {
@@ -153,4 +152,4 @@ const sidebars = {
   ],
 };
 
-module.exports = sidebars;
+export default sidebars;
diff --git a/website/versioned_docs/version-2.0.1/guides/docs/sidebar/index.mdx b/website/versioned_docs/version-2.0.1/guides/docs/sidebar/index.mdx
@@ -201,8 +201,8 @@ A real-world example from the Docusaurus site:
 ```mdx-code-block
 import CodeBlock from '@theme/CodeBlock';
 
-<CodeBlock language="js" title="sidebars.js">
-  {require('!!raw-loader!@site/sidebars.js')
+<CodeBlock language="js" title="sidebars.ts">
+  {require('!!raw-loader!@site/sidebars.ts')
     .default
     .split('\n')
     // remove comments

diff --git a/website/versioned_docs/version-2.1.0/guides/docs/sidebar/index.mdx b/website/versioned_docs/version-2.1.0/guides/docs/sidebar/index.mdx
@@ -201,7 +201,7 @@ A real-world example from the Docusaurus site:
 import CodeBlock from '@theme/CodeBlock';
 
 <CodeBlock language="js" title="sidebars.js">
-  {require('!!raw-loader!@site/sidebars.js')
+  {require('!!raw-loader!@site/sidebars.ts')
     .default
     .split('\n')
     // remove comments

diff --git a/website/versioned_docs/version-2.2.0/guides/docs/sidebar/index.mdx b/website/versioned_docs/version-2.2.0/guides/docs/sidebar/index.mdx
@@ -201,7 +201,7 @@ A real-world example from the Docusaurus site:
 import CodeBlock from '@theme/CodeBlock';
 
 <CodeBlock language="js" title="sidebars.js">
-  {require('!!raw-loader!@site/sidebars.js')
+  {require('!!raw-loader!@site/sidebars.ts')
     .default
     .split('\n')
     // remove comments

diff --git a/website/versioned_docs/version-2.3.1/guides/docs/sidebar/index.mdx b/website/versioned_docs/version-2.3.1/guides/docs/sidebar/index.mdx
@@ -201,7 +201,7 @@ A real-world example from the Docusaurus site:
 import CodeBlock from '@theme/CodeBlock';
 
 <CodeBlock language="js" title="sidebars.js">
-  {require('!!raw-loader!@site/sidebars.js')
+  {require('!!raw-loader!@site/sidebars.ts')
     .default
     .split('\n')
     // remove comments

diff --git a/website/versioned_docs/version-2.4.3/guides/docs/sidebar/index.mdx b/website/versioned_docs/version-2.4.3/guides/docs/sidebar/index.mdx
@@ -201,7 +201,7 @@ A real-world example from the Docusaurus site:
 import CodeBlock from '@theme/CodeBlock';
 
 <CodeBlock language="js" title="sidebars.js">
-  {require('!!raw-loader!@site/sidebars.js')
+  {require('!!raw-loader!@site/sidebars.ts')
     .default
     .split('\n')
     // remove comments

diff --git a/website/versioned_docs/version-3.0.0-beta.0/guides/docs/sidebar/index.mdx b/website/versioned_docs/version-3.0.0-beta.0/guides/docs/sidebar/index.mdx
@@ -201,7 +201,7 @@ A real-world example from the Docusaurus site:
 import CodeBlock from '@theme/CodeBlock';
 
 <CodeBlock language="js" title="sidebars.js">
-  {require('!!raw-loader!@site/sidebars.js')
+  {require('!!raw-loader!@site/sidebars.ts')
     .default
     .split('\n')
     // remove comments