From ac6f15cb277c893bb7868a3023b1b48120a32078 Mon Sep 17 00:00:00 2001 From: Pete Hayes Date: Tue, 17 Jan 2017 00:11:39 +0000 Subject: [PATCH 1/2] Add docs for --dest-dir option --- book-example/src/cli/build.md | 4 ++++ book-example/src/cli/serve.md | 6 +++++- book-example/src/cli/watch.md | 4 ++++ 3 files changed, 13 insertions(+), 1 deletion(-) diff --git a/book-example/src/cli/build.md b/book-example/src/cli/build.md index 9fe42be30d..0c296541a5 100644 --- a/book-example/src/cli/build.md +++ b/book-example/src/cli/build.md @@ -26,6 +26,10 @@ mdbook build path/to/book When you use the `--open` (`-o`) option, mdbook will open the rendered book in your default web browser after building it. +#### --dest-dir + +The `--dest-dir` (`-d`) option allows you to change the output directory for your book. + ------------------- ***note:*** *make sure to run the build command in the root directory and not in the source directory* diff --git a/book-example/src/cli/serve.md b/book-example/src/cli/serve.md index 39f1c6b89f..24221c8e71 100644 --- a/book-example/src/cli/serve.md +++ b/book-example/src/cli/serve.md @@ -31,8 +31,12 @@ If you were to want live reloading for this you would need to proxy the websocke When you use the `--open` (`-o`) option, mdbook will open the book in your your default web browser after starting the server. +#### --dest-dir + +The `--dest-dir` (`-d`) option allows you to change the output directory for your book. + ----- ***note:*** *the `serve` command has not gotten a lot of testing yet, there could be some rough edges. If you discover a problem, please report it [on Github](https://github.com/azerupi/mdBook/issues)* -***note***: +***note***: diff --git a/book-example/src/cli/watch.md b/book-example/src/cli/watch.md index 79117b3fc0..8b11047609 100644 --- a/book-example/src/cli/watch.md +++ b/book-example/src/cli/watch.md @@ -17,6 +17,10 @@ mdbook watch path/to/book When you use the `--open` (`-o`) option, mdbook will open the rendered book in your default web browser. +#### --dest-dir + +The `--dest-dir` (`-d`) option allows you to change the output directory for your book. + ----- ***note:*** *the `watch` command has not gotten a lot of testing yet, there could be some rough edges. If you discover a problem, please report it [on Github](https://github.com/azerupi/mdBook/issues)* From 32814f6f71eaa02fab107243fb8f109d8b5b9db7 Mon Sep 17 00:00:00 2001 From: Pete Hayes Date: Tue, 17 Jan 2017 00:15:18 +0000 Subject: [PATCH 2/2] Remove blank ***note*** section --- book-example/src/cli/serve.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/book-example/src/cli/serve.md b/book-example/src/cli/serve.md index 24221c8e71..e4578c999e 100644 --- a/book-example/src/cli/serve.md +++ b/book-example/src/cli/serve.md @@ -38,5 +38,3 @@ The `--dest-dir` (`-d`) option allows you to change the output directory for you ----- ***note:*** *the `serve` command has not gotten a lot of testing yet, there could be some rough edges. If you discover a problem, please report it [on Github](https://github.com/azerupi/mdBook/issues)* - -***note***: