mirror of
https://github.com/Unleash/unleash.git
synced 2025-03-18 00:19:49 +01:00
Docusaurus 3.6 (#8684)
Upgrading to Docusaurus 3.6 and v4.2 of the OpenAPI plugin (which is quite a significant update)
This commit is contained in:
parent
b141981f91
commit
8f18c2b194
@ -37,23 +37,25 @@ yarn build
|
|||||||
|
|
||||||
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
||||||
|
|
||||||
## Deployment
|
## Cleaning dependencies and caches
|
||||||
|
|
||||||
|
If you're upgrading a lot of dependencies, it's always good to delete the `node_modules` directory and clean the various caches.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
|
rm -rf node_modules
|
||||||
|
rm -rf .docusaurus
|
||||||
|
rm -rf docs/reference/api/unleash
|
||||||
```
|
```
|
||||||
|
|
||||||
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
|
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
||||||
### `TypeError: source_default(...).bold is not a function`
|
### `TypeError: source_default(...).bold is not a function`
|
||||||
|
|
||||||
If you get an error like this, it's probably due to a formatting issue within one of the markdown files. It could be
|
If you get an error like this, it's probably due to a formatting issue within one of the markdown files. It could be
|
||||||
|
|
||||||
- unescaped angle brackets (markdown will try to parse `<your-key>` (when it's not quoted) as HTML, which breaks the build)
|
- unescaped angle brackets (markdown will try to parse `<your-key>` (when it's not quoted) as HTML, which breaks the build)
|
||||||
- incorrectly formatted titles or missing pieces of files
|
- incorrectly formatted titles or missing pieces of files
|
||||||
- a lot of other stuff.
|
- a lot of other stuff.
|
||||||
|
|
||||||
```console
|
```console
|
||||||
Component Figure was not imported, exported, or provided by MDXProvider as global scope
|
Component Figure was not imported, exported, or provided by MDXProvider as global scope
|
||||||
|
@ -20,15 +20,15 @@
|
|||||||
"test": "NODE_ENV=test node --trace-warnings ../node_modules/.bin/jest remote-content"
|
"test": "NODE_ENV=test node --trace-warnings ../node_modules/.bin/jest remote-content"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@docusaurus/core": "^3.5.2",
|
"@docusaurus/core": "^3.6.0",
|
||||||
"@docusaurus/plugin-client-redirects": "^3.5.2",
|
"@docusaurus/plugin-client-redirects": "^3.6.0",
|
||||||
"@docusaurus/plugin-google-analytics": "^3.5.2",
|
"@docusaurus/plugin-google-analytics": "^3.6.0",
|
||||||
"@docusaurus/preset-classic": "^3.5.2",
|
"@docusaurus/preset-classic": "^3.6.0",
|
||||||
"@docusaurus/remark-plugin-npm2yarn": "3.5.2",
|
"@docusaurus/remark-plugin-npm2yarn": "3.6.0",
|
||||||
"@mdx-js/react": "^3.1.0",
|
"@mdx-js/react": "^3.1.0",
|
||||||
"docusaurus-plugin-openapi-docs": "^4.1.0",
|
"docusaurus-plugin-openapi-docs": "^4.2.0",
|
||||||
"docusaurus-plugin-remote-content": "^4.0.0",
|
"docusaurus-plugin-remote-content": "^4.0.0",
|
||||||
"docusaurus-theme-openapi-docs": "^4.1.0",
|
"docusaurus-theme-openapi-docs": "^4.2.0",
|
||||||
"git-url-parse": "^15.0.0",
|
"git-url-parse": "^15.0.0",
|
||||||
"plugin-image-zoom": "flexanalytics/plugin-image-zoom",
|
"plugin-image-zoom": "flexanalytics/plugin-image-zoom",
|
||||||
"prism-react-renderer": "^2.4.0",
|
"prism-react-renderer": "^2.4.0",
|
||||||
@ -50,8 +50,8 @@
|
|||||||
]
|
]
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@docusaurus/module-type-aliases": "^3.5.2",
|
"@docusaurus/module-type-aliases": "^3.6.0",
|
||||||
"@docusaurus/types": "^3.5.2",
|
"@docusaurus/types": "^3.6.0",
|
||||||
"@tsconfig/docusaurus": "2.0.3",
|
"@tsconfig/docusaurus": "2.0.3",
|
||||||
"@types/react": "^18.3.12",
|
"@types/react": "^18.3.12",
|
||||||
"typescript": "5.6.3"
|
"typescript": "5.6.3"
|
||||||
|
6703
website/yarn.lock
6703
website/yarn.lock
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user