-
Notifications
You must be signed in to change notification settings - Fork 1k
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.
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
[improve] add ci for home #2024
Conversation
# specific language governing permissions and limitations | ||
# under the License. | ||
|
||
name: DOC CI |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we include the link check ci in the check md file along with.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea. When executing npm run build
, it will verify whether the file referenced in sidebar.json exists. Indeed, the link in the .md file has not yet been verified. Let me try to see if it is easy to implement.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@yuluo-yx I'm really sorry, I made a mistake before. According to the configuration in docusaurus.config.js
, if a dead link occurs, the build process will be terminated, and the purpose of link verification can be achieved.
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'throw',
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
got it.
yes, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
What's changed?
Checklist
Add or update API