Mirrors/mdBook
2
0
Fork 0
mirror of https://github.com/rust-lang/mdBook synced 2024-12-14 14:52:37 +00:00
Code Issues Projects Releases Packages Wiki Activity

Make serve command note more prominent

Browse source
This commit is contained in:
Matt Ickstadt 2018-09-06 10:24:56 -05:00
parent 34356b87a0
commit a9f3be6f44
1 changed files with 3 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
book-example/src/cli/serve.md
View file

@ -5,6 +5,9 @@ The serve command is used to preview a book by serving it over HTTP at
changes, rebuilding the book and refreshing clients for each change. A websocket changes, rebuilding the book and refreshing clients for each change. 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
intended to be a complete HTTP server for a website.*
#### Specify a directory #### Specify a directory
The `serve` command can take a directory as an argument to use as the book's The `serve` command can take a directory as an argument to use as the book's
@ -43,8 +46,3 @@ The `--dest-dir` (`-d`) option allows you to change the output directory for the
book. Relative paths are interpreted relative to the book's root directory. If book. Relative paths are interpreted relative to the book's root directory. If
not specified it will default to the value of the `build.build-dir` key in not specified it will default to the value of the `build.build-dir` key in
`book.toml`, or to `./book`. `book.toml`, or to `./book`.
-----
***Note:*** *The `serve` command is for testing, and is not intended to be a
complete HTTP server for a website.*