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.
63 lines
1.7 KiB
JSON
63 lines
1.7 KiB
JSON
{
|
|
"name": "api-reference",
|
|
"version": "0.1.0",
|
|
"private": true,
|
|
"scripts": {
|
|
"dev": "next dev",
|
|
"dev:monorepo": "yarn dev -p 3000",
|
|
"build": "next build",
|
|
"build:dev": "NODE_ENV=test next build",
|
|
"build:prod": "NEXT_PUBLIC_ENV=production next build",
|
|
"start": "next start",
|
|
"start:monorepo": "yarn start -p 3000",
|
|
"lint": "next lint --fix"
|
|
},
|
|
"dependencies": {
|
|
"@mdx-js/loader": "^3.0.0",
|
|
"@mdx-js/react": "^3.0.0",
|
|
"@medusajs/icons": "^1.2.0",
|
|
"@medusajs/ui": "^2.4.1",
|
|
"@next/mdx": "14.1.3",
|
|
"@readme/openapi-parser": "^2.5.0",
|
|
"@types/mapbox__rehype-prism": "^0.8.0",
|
|
"@types/mdx": "^2.0.5",
|
|
"@types/node": "20.4.5",
|
|
"@types/react": "^18.2.0",
|
|
"@types/react-dom": "^18.2.0",
|
|
"@types/react-transition-group": "^4.4.6",
|
|
"autoprefixer": "10.4.14",
|
|
"clsx": "^2.0.0",
|
|
"docs-ui": "*",
|
|
"eslint-config-docs": "*",
|
|
"jsdom": "^22.1.0",
|
|
"json-schema": "^0.4.0",
|
|
"json-stringify-pretty-compact": "^4.0.0",
|
|
"next": "^14.1.3",
|
|
"next-mdx-remote": "^4.4.1",
|
|
"openapi-sampler": "^1.3.1",
|
|
"openapi-types": "^12.1.3",
|
|
"postcss": "8.4.27",
|
|
"prism-react-renderer": "2.3.1",
|
|
"react": "^18.2.0",
|
|
"react-dom": "^18.2.0",
|
|
"react-instantsearch": "^7.0.1",
|
|
"react-intersection-observer": "^9.5.3",
|
|
"react-tooltip": "^5.19.0",
|
|
"react-transition-group": "^4.4.5",
|
|
"slugify": "^1.6.6",
|
|
"swr": "^2.2.0",
|
|
"tailwind": "*",
|
|
"tailwindcss": "3.3.3",
|
|
"typescript": "5.1.6",
|
|
"yaml": "^2.3.1"
|
|
},
|
|
"devDependencies": {
|
|
"@next/bundle-analyzer": "^14.1.3",
|
|
"@types/jsdom": "^21.1.1",
|
|
"types": "*"
|
|
},
|
|
"engines": {
|
|
"node": ">=18.17.0"
|
|
}
|
|
}
|