Skip to content

Commit 48bfb96

Browse files
committed
Add instructions for local link checking to README
1 parent 1dafb4c commit 48bfb96

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ you to easily see and update changes you make.
2424
mdbook serve
2525
```
2626

27+
## Link checking
28+
29+
On CI, we automatically check if all intra-doc links in the Forge Markdown files are valid. If you would like to
30+
perform this check locally, install `mdbook-linkcheck` using `cargo install [email protected] --locked` and then
31+
simply run `mdbook build` or `mdbook serve`.
32+
2733
## JavaScript
2834

2935
Forge uses JavaScript to display dates for releases and "no tools breakage

0 commit comments

Comments
 (0)