actions
/
mdBook
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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

Fixes #1246
This commit is contained in:
Eldred Habert 2021-05-25 13:45:30 +02:00 committed by GitHub
parent 3c2b8cd10f
commit 89a2e39b80
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
guide/src/cli/build.md
View File

@ -7,7 +7,8 @@ mdbook build
``` ```
It will try to parse your `SUMMARY.md` file to understand the structure of your 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 The rendered output will maintain the same directory structure as the source for
convenience. Large books will therefore remain structured when rendered. convenience. Large books will therefore remain structured when rendered.

3
guide/src/cli/serve.md
View File

@ -8,7 +8,8 @@ mdbook serve
``` ```
The `serve` command watches the book's `src` directory for 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. connection is used to trigger the client-side refresh.
***Note:*** *The `serve` command is for testing a book's HTML output, and is not ***Note:*** *The `serve` command is for testing a book's HTML output, and is not

3
guide/src/cli/watch.md
View File

@ -3,7 +3,8 @@
The `watch` command is useful when you want your book to be rendered on every 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 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 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 #### Specify a directory