Skip to content

Commit e8436d2

Browse files
committed
Add some documentation for mdbook test
1 parent b40688c commit e8436d2

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

book-example/src/cli/test.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# The test command
2+
3+
It’s nice to be able to ensure that examples in documentation are current.
4+
mdBook supports a ‘test’ command, which will use Rustdoc to test out examples:
5+
6+
```bash
7+
$ mdbook test
8+
[*]: Testing file: "/mdBook/book-example/src/README.md”
9+
```

0 commit comments

Comments
 (0)