Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docusaurus 3.6 #8684

Merged
merged 2 commits into from
Nov 8, 2024
Merged

Docusaurus 3.6 #8684

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
810998f
Docusaurus 3.6
alvinometric Nov 6, 2024
7c7343a
Merge branch 'main' into alvin/docusaurus-36
alvinometric Nov 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions website/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

## 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
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

### `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

- 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
- a lot of other stuff.
- 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
- a lot of other stuff.

```console
Component Figure was not imported, exported, or provided by MDXProvider as global scope
Expand Down
18 changes: 9 additions & 9 deletions website/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@
"test": "NODE_ENV=test node --trace-warnings ../node_modules/.bin/jest remote-content"
},
"dependencies": {
"@docusaurus/core": "^3.5.2",
"@docusaurus/plugin-client-redirects": "^3.5.2",
"@docusaurus/plugin-google-analytics": "^3.5.2",
"@docusaurus/preset-classic": "^3.5.2",
"@docusaurus/remark-plugin-npm2yarn": "3.5.2",
"@docusaurus/core": "^3.6.0",
"@docusaurus/plugin-client-redirects": "^3.6.0",
"@docusaurus/plugin-google-analytics": "^3.6.0",
"@docusaurus/preset-classic": "^3.6.0",
"@docusaurus/remark-plugin-npm2yarn": "3.6.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-theme-openapi-docs": "^4.1.0",
"docusaurus-theme-openapi-docs": "^4.2.0",
"git-url-parse": "^15.0.0",
"plugin-image-zoom": "flexanalytics/plugin-image-zoom",
"prism-react-renderer": "^2.4.0",
Expand All @@ -50,8 +50,8 @@
]
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.5.2",
"@docusaurus/types": "^3.5.2",
"@docusaurus/module-type-aliases": "^3.6.0",
"@docusaurus/types": "^3.6.0",
"@tsconfig/docusaurus": "2.0.3",
"@types/react": "^18.3.12",
"typescript": "5.6.3"
Expand Down
Loading
Loading