Skip to content

Commit 2f43167

Browse files
committed
Add documentation for Serve feature
1 parent e861880 commit 2f43167

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# mdBook
1+
# mdBook
22

33
<table>
44
<tr>
@@ -100,6 +100,10 @@ Here are the main commands you will want to run, for a more exhaustive explanati
100100
101101
When you run this command, mdbook will watch your markdown files to rebuild the book on every change. This avoids having to come back to the terminal to type `mdbook build` over and over again.
102102
103+
- `mdbook serve`
104+
105+
Does the same thing as `mdbook watch` but additionally serves the book at `http://localhost:3000` (port is changeable) and reloads the browser when a change occures.
106+
103107
### As a library
104108
105109
Aside from the command line interface, this crate can also be used as a library. This means that you could integrate it in an existing project, like a web-app for example. Since the command line interface is just a wrapper around the library functionality, when you use this crate as a library you have full access to all the functionality of the command line interface with and easy to use API and more!

0 commit comments

Comments
 (0)