bb87db8342
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.
24 lines
641 B
TypeScript
24 lines
641 B
TypeScript
import type { MDXComponents } from "mdx/types"
|
|
import Security from "./Security"
|
|
import type { OpenAPIV3 } from "openapi-types"
|
|
import H2 from "./H2"
|
|
import { Link, MDXComponents as UiMDXComponents } from "docs-ui"
|
|
|
|
export type ScopeType = {
|
|
specs?: OpenAPIV3.Document
|
|
addToSidebar?: boolean
|
|
}
|
|
|
|
const getCustomComponents = (scope?: ScopeType): MDXComponents => {
|
|
return {
|
|
...UiMDXComponents,
|
|
Security: () => <Security specs={scope?.specs} />,
|
|
a: Link,
|
|
h2: (props: React.HTMLAttributes<HTMLHeadingElement>) => (
|
|
<H2 addToSidebar={scope?.addToSidebar} {...props} />
|
|
),
|
|
}
|
|
}
|
|
|
|
export default getCustomComponents
|