Files
medusa-store/www/apps/api-reference/components/MDXContent/Server/index.tsx
Shahed Nasser bb87db8342 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 07:47:35 +00:00

34 lines
921 B
TypeScript

/* eslint-disable @typescript-eslint/ban-ts-comment */
"use server"
import { MDXRemote } from "next-mdx-remote/rsc"
import getCustomComponents from "../../MDXComponents"
import type { ScopeType } from "../../MDXComponents"
import type { MDXRemoteProps } from "next-mdx-remote"
export type MDXContentServerProps = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
content: any
} & Partial<MDXRemoteProps>
const MDXContentServer = ({ content, ...props }: MDXContentServerProps) => {
return (
<>
{/* @ts-ignore promise error */}
<MDXRemote
source={content}
components={getCustomComponents((props.scope as ScopeType) || {})}
options={{
scope: props.scope,
mdxOptions: {
development: process.env.NEXT_PUBLIC_ENV === "development",
},
}}
{...props}
/>
</>
)
}
export default MDXContentServer