From 89a2e39b804efae5533d31e2f0fbe63bf041afa0 Mon Sep 17 00:00:00 2001 From: Eldred Habert Date: Tue, 25 May 2021 13:45:30 +0200 Subject: [PATCH] Mention missing file creation in build/watch/serve's docs (#1548) Fixes #1246 --- guide/src/cli/build.md | 3 ++- guide/src/cli/serve.md | 3 ++- guide/src/cli/watch.md | 3 ++- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/guide/src/cli/build.md b/guide/src/cli/build.md index 2521a640..71f1c48c 100644 --- a/guide/src/cli/build.md +++ b/guide/src/cli/build.md @@ -7,7 +7,8 @@ mdbook build ``` It will try to parse your `SUMMARY.md` file to understand the structure of your -book and fetch the corresponding files. +book and fetch the corresponding files. Note that files mentioned in `SUMMARY.md` +but not present will be created. The rendered output will maintain the same directory structure as the source for convenience. Large books will therefore remain structured when rendered. diff --git a/guide/src/cli/serve.md b/guide/src/cli/serve.md index 016d3c67..62ea26c2 100644 --- a/guide/src/cli/serve.md +++ b/guide/src/cli/serve.md @@ -8,7 +8,8 @@ mdbook serve ``` The `serve` command watches the book's `src` directory for -changes, rebuilding the book and refreshing clients for each change. A websocket +changes, rebuilding the book and refreshing clients for each change; this includes +re-creating deleted files still mentioned in `SUMMARY.md`! A websocket connection is used to trigger the client-side refresh. ***Note:*** *The `serve` command is for testing a book's HTML output, and is not diff --git a/guide/src/cli/watch.md b/guide/src/cli/watch.md index bc8c3821..3522f43c 100644 --- a/guide/src/cli/watch.md +++ b/guide/src/cli/watch.md @@ -3,7 +3,8 @@ The `watch` command is useful when you want your book to be rendered on every file change. You could repeatedly issue `mdbook build` every time a file is changed. But using `mdbook watch` once will watch your files and will trigger a -build automatically whenever you modify a file. +build automatically whenever you modify a file; this includes re-creating +deleted files still mentioned in `SUMMARY.md`! #### Specify a directory