Skip to content

Commit

Permalink
docs: updated dependencies (#5248)
Browse files Browse the repository at this point in the history
Also, now that no broken links are reported, modified the config to
throw if any are introduced.

Note that the version of @mdx-js/react is fixed to 3.0.0, as 3.0.1 seems
to break the anchor collection in docusaurus' mdx-loader. Not sure if
docusaurus is interacting with it erroniously or if @mdx-js/react
unintentionally broke what used to work, or if maybe one of
@mdx-js/react's dependencies broke something, so I haven't reported this
to either repo yet.


----

Not sure why renovate still didn't pick up the new plugin version. My
best guess is because it's not part of the root's workspace. If
successfully enabled, it might try to update @mdx-js/react, and right
now, it will probably fail due to the new version introducing broken
anchors.
  • Loading branch information
boenrobot committed Feb 16, 2024
1 parent 5b68958 commit 0b6d3dd
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 16 deletions.
4 changes: 4 additions & 0 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,10 @@ module.exports = {
projectName: 'mikro-orm',
scripts: ['/js/custom.js'],
trailingSlash: false,
onBrokenLinks: 'throw',
onBrokenAnchors: 'throw',
onBrokenMarkdownLinks: 'throw',
onDuplicateRoutes: 'throw',
themeConfig: {
algolia: {
apiKey: '83015544b5b03ca27af77c74a25d4868',
Expand Down
7 changes: 4 additions & 3 deletions docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,14 @@
},
"dependencies": {
"@docusaurus/core": "^3.1.1",
"@docusaurus/mdx-loader": "^3.1.1",
"@docusaurus/plugin-client-redirects": "^3.1.1",
"@docusaurus/preset-classic": "^3.1.1",
"@docusaurus/remark-plugin-npm2yarn": "^3.1.1",
"@giscus/react": "^2.4.0",
"@mdx-js/react": "^3.0.0",
"@mdx-js/react": "3.0.0",
"classnames": "^2.5.1",
"docusaurus-plugin-typedoc-api": "^4.1.0",
"docusaurus-plugin-typedoc-api": "^4.2.0",
"prism-react-renderer": "^2.3.1",
"react": "^18.2.0",
"react-dom": "^18.2.0",
Expand All @@ -42,6 +43,6 @@
"@docusaurus/types": "^3.1.1",
"@types/react": "^18.2.55",
"@types/react-dom": "^18.2.19",
"prettier": "^3.1.1"
"prettier": "^3.2.5"
}
}
28 changes: 15 additions & 13 deletions docs/yarn.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 0b6d3dd

Please sign in to comment.