docs: prep for v2 documentation (#6710)

This PR includes documentation that preps for v2 docs (but doesn't introduce new docs). _Note: The number of file changes in the PR is due to find-and-replace within the `references` which is unavoidable. Let me know if I should move it to another PR._ ## Changes - Change Medusa version in base OAS used for v2. - Fix to docblock generator related to not catching all path parameters. - Added typedoc plugin that generates ER Diagrams, which will be used specifically for data model references in commerce modules. - Changed OAS tool to output references in `www/apps/api-reference/specs-v2` directory when the `--v2` option is used. - Added a version switcher to the API reference to switch between V1 and V2. This switcher is enabled by an environment variable, so it won't be visible/usable at the moment. - Upgraded docusaurus to v3.0.1 - Added new Vale rules to ensure correct spelling of Medusa Admin and module names. - Added new components to the `docs-ui` package that will be used in future documentation changes.
2024-03-18 09:47:35 +02:00
parent 56a6ec0227
commit bb87db8342
2008 changed files with 15716 additions and 10536 deletions
@@ -0,0 +1,84 @@
+"use client"
+
+import React, { useMemo } from "react"
+import clsx from "clsx"
+import { CodeBlockStyle } from ".."
+import { useColorMode } from "@/providers"
+import { Badge, BadgeVariant } from "@/components"
+
+export type CodeBlockHeaderMeta = {
+  badgeLabel?: string
+  badgeColor?: BadgeVariant
+}
+
+type CodeBlockHeaderProps = {
+  children?: React.ReactNode
+  title?: string
+  blockStyle?: CodeBlockStyle
+} & CodeBlockHeaderMeta
+
+export const CodeBlockHeader = ({
+  children,
+  title,
+  blockStyle = "loud",
+  badgeLabel,
+  badgeColor,
+}: CodeBlockHeaderProps) => {
+  const { colorMode } = useColorMode()
+
+  const borderColor = useMemo(
+    () =>
+      clsx(
+        blockStyle === "loud" && [
+          colorMode === "light" && "border-medusa-code-border",
+          colorMode === "dark" && "border-medusa-border-base",
+        ],
+        blockStyle === "subtle" && [
+          colorMode === "light" && "border-medusa-border-base",
+          colorMode === "dark" && "border-medusa-code-border",
+        ]
+      ),
+    [blockStyle, colorMode]
+  )
+  return (
+    <div
+      className={clsx(
+        "py-docs_0.75 rounded-t-docs_DEFAULT px-docs_1 mb-0",
+        "flex gap-docs_2 items-start justify-between",
+        blockStyle === "loud" && [
+          colorMode === "light" && "bg-medusa-code-bg-header",
+          colorMode === "dark" && "bg-medusa-bg-base",
+        ],
+        blockStyle === "subtle" && [
+          colorMode === "light" && "bg-medusa-bg-component",
+          colorMode === "dark" && "bg-medusa-code-bg-header",
+        ],
+        borderColor && `border border-b-0 ${borderColor}`
+      )}
+    >
+      {children}
+      {title && (
+        <div
+          className={clsx(
+            "txt-compact-small-plus",
+            blockStyle === "loud" && [
+              colorMode === "light" && "text-medusa-code-text-subtle",
+              colorMode === "dark" && "text-medusa-fg-muted",
+            ],
+            blockStyle === "subtle" && [
+              colorMode === "light" && "text-medusa-fg-subtle",
+              colorMode === "dark" && "text-medusa-code-text-subtle",
+            ]
+          )}
+        >
+          {title}
+        </div>
+      )}
+      {badgeLabel && (
+        <Badge variant={badgeColor || "orange"} className="font-base">
+          {badgeLabel}
+        </Badge>
+      )}
+    </div>
+  )
+}