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:
52
www/packages/docs-ui/src/components/Npm2YarnCode/index.tsx
Normal file
52
www/packages/docs-ui/src/components/Npm2YarnCode/index.tsx
Normal file
@@ -0,0 +1,52 @@
|
||||
import React from "react"
|
||||
import { CodeBlockMetaFields, LegacyCodeTabs } from "../.."
|
||||
import convert from "npm-to-yarn"
|
||||
|
||||
type Npm2YarnCodeProps = {
|
||||
npmCode: string
|
||||
} & Omit<CodeBlockMetaFields, "npm2yarn">
|
||||
|
||||
export const Npm2YarnCode = ({ npmCode, ...rest }: Npm2YarnCodeProps) => {
|
||||
// convert npm code
|
||||
const yarnCode = convert(npmCode, "yarn").replaceAll(/([^\s])&&/g, "$1 &&")
|
||||
const pnpmCode = convert(npmCode, "pnpm").replaceAll(/([^\s])&&/g, "$1 &&")
|
||||
const lang = "bash"
|
||||
|
||||
const { title = "", ...codeOptions } = rest
|
||||
|
||||
return (
|
||||
<LegacyCodeTabs
|
||||
group="npm2yarn"
|
||||
title={title}
|
||||
tabs={[
|
||||
{
|
||||
label: "npm",
|
||||
value: "npm",
|
||||
code: {
|
||||
source: npmCode,
|
||||
lang,
|
||||
...codeOptions,
|
||||
},
|
||||
},
|
||||
{
|
||||
label: "yarn",
|
||||
value: "yarn",
|
||||
code: {
|
||||
source: yarnCode,
|
||||
lang,
|
||||
...codeOptions,
|
||||
},
|
||||
},
|
||||
{
|
||||
label: "pnpm",
|
||||
value: "pnpm",
|
||||
code: {
|
||||
source: pnpmCode,
|
||||
lang,
|
||||
...codeOptions,
|
||||
},
|
||||
},
|
||||
]}
|
||||
/>
|
||||
)
|
||||
}
|
||||
Reference in New Issue
Block a user