docs: create docs workspace (#5174)

* docs: migrate ui docs to docs universe * created yarn workspace * added eslint and tsconfig configurations * fix eslint configurations * fixed eslint configurations * shared tailwind configurations * added shared ui package * added more shared components * migrating more components * made details components shared * move InlineCode component * moved InputText * moved Loading component * Moved Modal component * moved Select components * Moved Tooltip component * moved Search components * moved ColorMode provider * Moved Notification components and providers * used icons package * use UI colors in api-reference * moved Navbar component * used Navbar and Search in UI docs * added Feedback to UI docs * general enhancements * fix color mode * added copy colors file from ui-preset * added features and enhancements to UI docs * move Sidebar component and provider * general fixes and preparations for deployment * update docusaurus version * adjusted versions * fix output directory * remove rootDirectory property * fix yarn.lock * moved code component * added vale for all docs MD and MDX * fix tests * fix vale error * fix deployment errors * change ignore commands * add output directory * fix docs test * general fixes * content fixes * fix announcement script * added changeset * fix vale checks * added nofilter option * fix vale error
2023-09-21 20:57:15 +03:00
parent 19c5d5ba36
commit fa7c94b4cc
3209 changed files with 32188 additions and 31018 deletions
@@ -0,0 +1,54 @@
+import clsx from "clsx"
+import "../../../css/globals.css"
+import Navbar from "@/components/Navbar"
+import { Inter } from "next/font/google"
+import { Roboto_Mono } from "next/font/google"
+import Providers from "../../../providers"
+import { Sidebar } from "docs-ui"
+
+export const metadata = {
+  title: "Medusa API Reference",
+  description: "Check out Medusa's API reference",
+}
+
+const inter = Inter({
+  subsets: ["latin"],
+  variable: "--font-inter",
+  weight: ["400", "500"],
+})
+
+const robotoMono = Roboto_Mono({
+  subsets: ["latin"],
+  variable: "--font-roboto-mono",
+})
+
+export default function RootLayout({
+  children,
+}: {
+  children: React.ReactNode
+}) {
+  return (
+    <html lang="en" className={clsx("h-full w-full")}>
+      <body
+        className={clsx(
+          inter.variable,
+          robotoMono.variable,
+          "bg-docs-bg dark:bg-docs-bg-dark font-base text-medium h-full w-full",
+          "text-medusa-fg-subtle dark:text-medusa-fg-subtle-dark"
+        )}
+      >
+        <Providers>
+          <div className="w-full">
+            <Navbar />
+            <div className="max-w-xxl mx-auto flex w-full px-1.5">
+              <Sidebar />
+              <main className="lg:w-ref-main relative mt-4 w-full flex-1 lg:mt-7">
+                {children}
+              </main>
+            </div>
+          </div>
+        </Providers>
+      </body>
+    </html>
+  )
+}
@@ -0,0 +1,65 @@
+import AreaProvider from "@/providers/area"
+import AdminDescription from "../../_mdx/admin.mdx"
+import StoreDescription from "../../_mdx/store.mdx"
+import ClientLibraries from "../../_mdx/client-libraries.mdx"
+import Section from "@/components/Section"
+import Tags from "@/components/Tags"
+import type { Area } from "@/types/openapi"
+import DividedLayout from "@/layouts/Divided"
+import { capitalize } from "docs-ui"
+import PageTitleProvider from "../../../providers/page-title"
+
+type ReferencePageProps = {
+  params: {
+    area: Area
+  }
+}
+
+const ReferencePage = async ({ params: { area } }: ReferencePageProps) => {
+  return (
+    <AreaProvider area={area}>
+      <PageTitleProvider>
+        <h1 className="!text-h2 block lg:hidden">
+          Medusa {capitalize(area)} API Reference
+        </h1>
+        <DividedLayout
+          mainContent={
+            <Section>
+              <h1 className="!text-h2 hidden lg:block">
+                Medusa {capitalize(area)} API Reference
+              </h1>
+              {area.includes("admin") && <AdminDescription />}
+              {area.includes("store") && <StoreDescription />}
+            </Section>
+          }
+          codeContent={<ClientLibraries />}
+          className="flex-col-reverse"
+        />
+        <Tags />
+      </PageTitleProvider>
+    </AreaProvider>
+  )
+}
+
+export default ReferencePage
+
+export function generateMetadata({ params: { area } }: ReferencePageProps) {
+  return {
+    title: `Medusa ${capitalize(area)} API Reference`,
+    description: `REST API reference for the Medusa ${area} API. This reference includes code snippets and examples for Medusa JS Client and cURL.`,
+    metadataBase: process.env.NEXT_PUBLIC_BASE_URL,
+  }
+}
+
+export const dynamicParams = false
+
+export async function generateStaticParams() {
+  return [
+    {
+      area: "admin",
+    },
+    {
+      area: "store",
+    },
+  ]
+}