Build Error due to Broken Links #37
Labels
kind/bug
Categorizes issue or PR as related to a bug.
lifecycle/stale
Denotes an issue or PR has remained open with no activity and has become stale.
While executing the
npm run build
command, the build process failed due to broken links detected by Docusaurus. The error message indicates that there are broken links on pages/sdks/api
and the Home Page (/
). The detailed error message is as follows:[ERROR] Unable to build website for locale zh-Hans.
[ERROR] Error: Docusaurus found broken links!
Please check the pages of your site in the list below, and make sure you don't reference any path that does not exist.
Note: it's possible to ignore broken links with the 'onBrokenLinks' Docusaurus configuration, and let the build pass.
Exhaustive list of all broken links found:
On source page path = /sdks/api:
-> linking to docs/sdks/api/msg/index.mdx (resolved as: /sdks/docs/sdks/api/msg/index.mdx)
On source page path = /:
-> linking to /restapi/userManagement/userRegister
at throwError (C:\Users\smile\Desktop\web-docs\openim-docs\node_modules@docusaurus\logger\lib\index.js:76:11)
...
Steps to Reproduce:
npm install
to install the dependencies.npm run build
to build the documentation.Expected Result:
The documentation should build without any errors.
Actual Result:
The build process fails due to broken links.
Suggested Fix:
onBrokenLinks: 'ignore'
indocusaurus.config.js
allows the build to pass, although it's more advisable to fix the broken links for a better user experience.Environment:
Additional Context:
Add any other context about the problem here.
Attachments:
The text was updated successfully, but these errors were encountered: