deps: Add scalar package

pulsate-dev · Aug 18, 2024 · 567884e · 567884e
1 parent 5b8ef41
commit 567884e
Show file tree

Hide file tree

Showing 7 changed files with 2,773 additions and 19 deletions.
diff --git a/components/ScalarAPIReference.tsx b/components/ScalarAPIReference.tsx
@@ -11,10 +11,16 @@ import '@scalar/api-reference-react/style.css';
  * @return The API reference component.
  */
 export default function ScalarAPIReference() {
+  // https://github.com/scalar/scalar/blob/main/documentation/configuration.md
   return (
     <ApiReferenceReact
       configuration={{
-        theme: 'none',
+        isEditable: false,
+        darkMode: true,
+        hideDarkModeToggle: true,
+        searchHotKey: 's',
+        theme: 'bluePlanet',
+        // TODO: Support testing the API reference with a staring server
         spec: {
           url: 'https://raw.githubusercontent.com/pulsate-dev/pulsate/main/resources/schema.json',
         },

diff --git a/package.json b/package.json
@@ -17,6 +17,8 @@
 		"postinstall": "lefthook install"
 	},
 	"dependencies": {
+		"@scalar/api-reference-react": "^0.3.79",
+		"@scalar/nextjs-api-reference": "^0.4.79",
 		"next": "^14.2.5",
 		"nextra": "^2.13.4",
 		"nextra-theme-docs": "^2.13.4",

diff --git a/pages/_meta.en.json b/pages/_meta.en.json
@@ -28,15 +28,5 @@
     "theme": {
       "layout": "raw"
     }
-  },
-  "other": {
-    "title": "Other",
-    "type": "menu",
-    "items": {
-      "api-reference": {
-        "title": "API Reference",
-        "href": "/api"
-      }
-    }
   }
 }
diff --git a/pages/_meta.ja.json b/pages/_meta.ja.json
@@ -34,7 +34,7 @@
     "type": "menu",
     "items": {
       "api-reference": {
-        "title": "API リファレンス",
+        "title": "Pulsate API Document",
         "href": "/api"
       }
     }

diff --git a/pages/api.en.mdx b/pages/api.en.mdx