Skip to content

Commit 89a2e39

Browse files
authored
Mention missing file creation in build/watch/serve's docs (#1548)
Fixes #1246
1 parent 3c2b8cd commit 89a2e39

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

guide/src/cli/build.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ mdbook build
77
```
88

99
It will try to parse your `SUMMARY.md` file to understand the structure of your
10-
book and fetch the corresponding files.
10+
book and fetch the corresponding files. Note that files mentioned in `SUMMARY.md`
11+
but not present will be created.
1112

1213
The rendered output will maintain the same directory structure as the source for
1314
convenience. Large books will therefore remain structured when rendered.

guide/src/cli/serve.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ mdbook serve
88
```
99

1010
The `serve` command watches the book's `src` directory for
11-
changes, rebuilding the book and refreshing clients for each change. A websocket
11+
changes, rebuilding the book and refreshing clients for each change; this includes
12+
re-creating deleted files still mentioned in `SUMMARY.md`! A websocket
1213
connection is used to trigger the client-side refresh.
1314

1415
***Note:*** *The `serve` command is for testing a book's HTML output, and is not

guide/src/cli/watch.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
The `watch` command is useful when you want your book to be rendered on every
44
file change. You could repeatedly issue `mdbook build` every time a file is
55
changed. But using `mdbook watch` once will watch your files and will trigger a
6-
build automatically whenever you modify a file.
6+
build automatically whenever you modify a file; this includes re-creating
7+
deleted files still mentioned in `SUMMARY.md`!
78

89
#### Specify a directory
910

0 commit comments

Comments
 (0)