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.
82 lines
2.4 KiB
JSON
82 lines
2.4 KiB
JSON
{
|
|
"name": "docs",
|
|
"version": "0.0.0",
|
|
"private": true,
|
|
"scripts": {
|
|
"docusaurus": "docusaurus",
|
|
"dev": "docusaurus clear && docusaurus start",
|
|
"dev:monorepo": "yarn dev --port 3001",
|
|
"build": "docusaurus build",
|
|
"swizzle": "docusaurus swizzle",
|
|
"deploy": "docusaurus deploy",
|
|
"clear": "docusaurus clear",
|
|
"start": "docusaurus serve",
|
|
"start:monorepo": "yarn start --port 3001",
|
|
"write-translations": "docusaurus write-translations",
|
|
"write-heading-ids": "docusaurus write-heading-ids",
|
|
"lint": "eslint --ext .js,.jsx,.ts,.tsx . --fix",
|
|
"lint:content": "eslint --no-eslintrc -c .content.eslintrc.js content --fix",
|
|
"diagram2code:generate": "docusaurus diagram2code:generate"
|
|
},
|
|
"dependencies": {
|
|
"@babel/preset-react": "^7.18.6",
|
|
"@cloudinary/react": "^1.11.2",
|
|
"@cloudinary/url-gen": "^1.9.2",
|
|
"@docusaurus/core": "latest",
|
|
"@docusaurus/preset-classic": "latest",
|
|
"@docusaurus/remark-plugin-npm2yarn": "latest",
|
|
"@docusaurus/theme-mermaid": "latest",
|
|
"@mdx-js/mdx": "3.0.0",
|
|
"@mdx-js/react": "3",
|
|
"@medusajs/icons": "^1.2.0",
|
|
"@svgr/webpack": "6.2.1",
|
|
"@swc/core": "^1.3.102",
|
|
"autoprefixer": "^10.4.14",
|
|
"clsx": "^1.1.1",
|
|
"docs-ui": "*",
|
|
"docusaurus-plugin-image-zoom": "^1.0.1",
|
|
"dotenv": "^16.0.3",
|
|
"eslint": "^8.49.0",
|
|
"eslint-config-docs": "*",
|
|
"file-loader": "^6.2.0",
|
|
"lodash": "^4.17.21",
|
|
"mdast-util-mdx": "^3.0.0",
|
|
"postcss": "^8.4.21",
|
|
"prism-react-renderer": "^2.3.0",
|
|
"react": "^18.2.0",
|
|
"react-dom": "^18.2.0",
|
|
"react-tooltip": "5.7.4",
|
|
"react-transition-group": "^4.4.5",
|
|
"tailwind": "*",
|
|
"tailwindcss": "^3.3.2",
|
|
"tsconfig": "*",
|
|
"url-loader": "^4.1.1"
|
|
},
|
|
"browserslist": {
|
|
"production": [
|
|
">0.5%",
|
|
"not dead",
|
|
"not op_mini all"
|
|
],
|
|
"development": [
|
|
"last 1 chrome version",
|
|
"last 1 firefox version",
|
|
"last 1 safari version"
|
|
]
|
|
},
|
|
"devDependencies": {
|
|
"@babel/plugin-proposal-decorators": "^7.22.15",
|
|
"@docusaurus/module-type-aliases": "latest",
|
|
"@docusaurus/tsconfig": "latest",
|
|
"@docusaurus/types": "latest",
|
|
"@types/react": "^18.2.0",
|
|
"@types/react-dom": "^18.2.0",
|
|
"@types/react-transition-group": "^4.4.6",
|
|
"swc-loader": "^0.2.3",
|
|
"typescript": "~5.2.2"
|
|
},
|
|
"engines": {
|
|
"node": ">=18.0"
|
|
}
|
|
}
|