1
1
# The serve command
2
2
3
- The serve command is used to preview a book by serving it over HTTP at
4
- ` localhost:3000 ` by default. Additionally it watches the book's directory for
3
+ The serve command is used to preview a book by serving it via HTTP at
4
+ ` localhost:3000 ` by default:
5
+
6
+ ``` bash
7
+ mdbook serve
8
+ ```
9
+
10
+ The ` serve ` command watches the book's ` src ` directory for
5
11
changes, rebuilding the book and refreshing clients for each change. A websocket
6
12
connection is used to trigger the client-side refresh.
7
13
@@ -17,24 +23,14 @@ root instead of the current working directory.
17
23
mdbook serve path/to/book
18
24
```
19
25
20
- #### Server options
21
-
22
- ` serve ` has four options: the HTTP port, the WebSocket port, the HTTP hostname
23
- to listen on, and the hostname for the browser to connect to for WebSockets.
26
+ ### Server options
24
27
25
- For example: suppose you have an nginx server for SSL termination which has a
26
- public address of 192.168.1.100 on port 80 and proxied that to 127.0.0.1 on port
27
- 8000\. To run use the nginx proxy do:
28
+ The ` serve ` hostname defaults to ` localhost ` , and the port defaults to ` 3000 ` . Either option can be specified on the command line:
28
29
29
30
``` bash
30
- mdbook serve path/to/book -p 8000 -n 127.0.0.1 --websocket-hostname 192.168.1.100
31
+ mdbook serve path/to/book -p 8000 -n 127.0.0.1
31
32
```
32
33
33
- If you were to want live reloading for this you would need to proxy the
34
- websocket calls through nginx as well from ` 192.168.1.100:<WS_PORT> ` to
35
- ` 127.0.0.1:<WS_PORT> ` . The ` -w ` flag allows for the websocket port to be
36
- configured.
37
-
38
34
#### --open
39
35
40
36
When you use the ` --open ` (` -o ` ) flag, mdbook will open the book in your
@@ -55,5 +51,5 @@ contain file patterns described in the [gitignore
55
51
documentation] ( https://git-scm.com/docs/gitignore ) . This can be useful for
56
52
ignoring temporary files created by some editors.
57
53
58
- _ Note: Only ` .gitignore ` from book root directory is used. Global
59
- ` $HOME/.gitignore ` or ` .gitignore ` files in parent directories are not used._
54
+ *** Note: *** * Only the ` .gitignore ` from the book root directory is used. Global
55
+ ` $HOME/.gitignore ` or ` .gitignore ` files in parent directories are not used.*
0 commit comments