feat(api): updates reference documentation

docusaurus.config.js → docusaurus.config.ts

@@ -1,30 +1,16 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
-
-const {themes} = require('prism-react-renderer');
+import type { ScalarOptions } from '@scalar/docusaurus'
+import type { Config } from '@docusaurus/types'
+import { themes } from 'prism-react-renderer'
+import fs from 'fs'
 const lightCodeTheme = themes.okaidia;
 const darkCodeTheme = themes.okaidia;
 
-const redocusaurus = [
-  "redocusaurus",
-  {
-    // Plugin Options for loading OpenAPI files
-    specs: [
-      {
-        spec: "openapi.yaml",
-        route: "/api/",
-      },
-    ],
-    // Theme Options for modifying how redoc renders them
-    theme: {
-      // Change with your site colors
-      primaryColor: "#1890ff",
-    },
-  },
-];
+// Read the openapi.yaml file
+const specFile = fs.readFileSync('./openapi.yaml', 'utf8')
 
-/** @type {import('@docusaurus/types').Config} */
-const config = {
+const config: Config = {
   title: "Mistral AI Large Language Models",
   tagline: "Documentation for the deployment and usage of Mistral AI's LLMs",
   favicon: "img/favicon.ico",
@@ -67,11 +53,13 @@ const config = {
         },
         blog: false,
         theme: {
-          customCss: require.resolve("./src/css/custom.css"),
+          customCss: [
+            require.resolve("./src/css/custom.css"),
+            require.resolve("./src/css/api-reference.css"),
+          ],
         },
       }),
     ],
-    redocusaurus,
   ],
 
   themeConfig:
@@ -110,7 +98,6 @@ const config = {
             position: "left",
             activeBaseRegex: "^/(?!api)",
           },
-          { to: "/api/", label: "API", position: "left" },
           {
             href: "https://github.com/mistralai/",
             label: "GitHub",
@@ -171,7 +158,22 @@ const config = {
         respectPrefersColorScheme: true,
       },
     }),
-    plugins: [require.resolve('docusaurus-lunr-search')],
+    plugins: [
+      require.resolve('docusaurus-lunr-search'),
+      [
+        '@scalar/docusaurus',
+        {
+          label: 'API',
+          route: '/api',
+          configuration: {
+            spec: {
+              content: specFile,
+            },
+            hideDarkModeToggle: true,
+          },
+        } as ScalarOptions,
+      ],
+    ],
 };
 
-module.exports = config;
+export default config;

package.json

@@ -18,15 +18,16 @@
     "@docusaurus/core": "3.5.2",
     "@docusaurus/preset-classic": "3.5.2",
     "@docusaurus/theme-common": "3.5.2",
+    "@docusaurus/types": "^3.7.0",
     "@easyops-cn/docusaurus-search-local": "^0.44.5",
     "@mdx-js/react": "^3.0.1",
+    "@scalar/docusaurus": "^0.4.211",
     "clsx": "^1.2.1",
     "docusaurus-lunr-search": "^3.4.0",
     "lunr": "^2.3.9",
     "prism-react-renderer": "^2.3.1",
     "react": "^18.3.1",
-    "react-dom": "^18.3.1",
-    "redocusaurus": "^2.1.1"
+    "react-dom": "^18.3.1"
   },
   "devDependencies": {
     "@docusaurus/module-type-aliases": "3.2.1",