Skip to content

Commit 6a5e5b1

Browse files
Added a note about how to use mdbook-linkcheck
1 parent dd6f925 commit 6a5e5b1

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,11 @@ for you to talk with someone who **does** know the code, or who wants
2525
to pair with you and figure it out. Then you can work on writing up
2626
what you learned.
2727

28+
To help prevent accidentally introducing broken links, we use the
29+
`mdbook-linkcheck`. If installed on your machine `mdbook` will automatically
30+
invoke this link checker, otherwise it will emit a warning saying it couldn't
31+
be found.
32+
33+
```
34+
$ cargo install mdbook-linkcheck
35+
```

0 commit comments

Comments
 (0)