Skip to content

Mention missing file creation in build/watch/serve's docs #1548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 25, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion guide/src/cli/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion guide/src/cli/serve.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 2 additions & 1 deletion guide/src/cli/watch.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down