From e8436d2fd2e16c3d8d019cd403386655d765b301 Mon Sep 17 00:00:00 2001 From: Steve Klabnik Date: Tue, 29 Dec 2015 17:58:56 -0500 Subject: [PATCH] Add some documentation for mdbook test --- book-example/src/cli/test.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 book-example/src/cli/test.md diff --git a/book-example/src/cli/test.md b/book-example/src/cli/test.md new file mode 100644 index 00000000..a9e6835b --- /dev/null +++ b/book-example/src/cli/test.md @@ -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” +```