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.
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
import React from "react"
|
||||
import ReactMarkdown from "react-markdown"
|
||||
import { ReactMarkdownOptions } from "react-markdown/lib/react-markdown"
|
||||
import { CodeMdx, Details, Kbd, Link } from "@/components"
|
||||
import { MDXComponents, LegacyLink } from "@/components"
|
||||
import clsx from "clsx"
|
||||
import { NormalComponents } from "react-markdown/lib/complex-types"
|
||||
import { SpecialComponents } from "react-markdown/lib/ast-to-react"
|
||||
@@ -21,7 +21,7 @@ export const MarkdownContent = ({
|
||||
<ReactMarkdown
|
||||
components={
|
||||
components || {
|
||||
code: CodeMdx,
|
||||
...MDXComponents,
|
||||
pre: ({
|
||||
className,
|
||||
children,
|
||||
@@ -33,68 +33,8 @@ export const MarkdownContent = ({
|
||||
</pre>
|
||||
)
|
||||
},
|
||||
kbd: Kbd,
|
||||
details: Details,
|
||||
a: Link,
|
||||
ul: ({
|
||||
className,
|
||||
children,
|
||||
...props
|
||||
}: React.HTMLAttributes<HTMLUListElement>) => {
|
||||
return (
|
||||
<ul
|
||||
{...props}
|
||||
className={clsx("list-disc px-docs_1 mb-docs_1.5", className)}
|
||||
>
|
||||
{children}
|
||||
</ul>
|
||||
)
|
||||
},
|
||||
ol: ({
|
||||
className,
|
||||
children,
|
||||
...props
|
||||
}: React.HTMLAttributes<HTMLOListElement>) => {
|
||||
return (
|
||||
<ol
|
||||
{...props}
|
||||
className={clsx(
|
||||
"list-decimal px-docs_1 mb-docs_1.5",
|
||||
className
|
||||
)}
|
||||
>
|
||||
{children}
|
||||
</ol>
|
||||
)
|
||||
},
|
||||
li: ({
|
||||
className,
|
||||
children,
|
||||
...props
|
||||
}: React.HTMLAttributes<HTMLLIElement>) => {
|
||||
return (
|
||||
<li
|
||||
className={clsx("text-medusa-fg-subtle", className)}
|
||||
{...props}
|
||||
>
|
||||
<span>{children}</span>
|
||||
</li>
|
||||
)
|
||||
},
|
||||
p: ({
|
||||
className,
|
||||
...props
|
||||
}: React.HTMLAttributes<HTMLParagraphElement>) => {
|
||||
return (
|
||||
<p
|
||||
className={clsx(
|
||||
"text-medusa-fg-subtle [&:not(:last-child)]:mb-docs_1.5 last:!mb-0",
|
||||
className
|
||||
)}
|
||||
{...props}
|
||||
/>
|
||||
)
|
||||
},
|
||||
// TODO replace with Link once we move away from Docusaurus
|
||||
a: LegacyLink,
|
||||
}
|
||||
}
|
||||
{...props}
|
||||
|
||||
Reference in New Issue
Block a user