mirror of
https://github.com/rust-lang/mdBook
synced 2024-12-14 06:42:35 +00:00
Add some documentation for mdbook test
This commit is contained in:
parent
b40688c880
commit
e8436d2fd2
1 changed files with 9 additions and 0 deletions
9
book-example/src/cli/test.md
Normal file
9
book-example/src/cli/test.md
Normal file
|
@ -0,0 +1,9 @@
|
|||
# The test command
|
||||
|
||||
It’s nice to be able to ensure that examples in documentation are current.
|
||||
mdBook supports a ‘test’ command, which will use Rustdoc to test out examples:
|
||||
|
||||
```bash
|
||||
$ mdbook test
|
||||
[*]: Testing file: "/mdBook/book-example/src/README.md”
|
||||
```
|
Loading…
Reference in a new issue