mdbook/book-example/src/cli/build.md
Bulat Musin 6af77a7792 Update documentation to reflect addition of clean subcommand. (#607)
* update documentation

Update README.md and User Guide to reflect addition of `clean`
subcommand. Do minor spelling fixes too.

* fix grammar in `clean` documentation
2018-02-18 15:04:04 +08:00

922 B

The build command

The build command is used to render your book:

mdbook build

It will try to parse your SUMMARY.md file to understand the structure of your book and fetch the corresponding files.

The rendered output will maintain the same directory structure as the source for convenience. Large books will therefore remain structured when rendered.

Specify a directory

Like init, the build command can take a directory as an argument to use instead of the current working directory.

mdbook build path/to/book

--open

When you use the --open (-o) option, mdbook will open the rendered book in your default web browser after building it.

--dest-dir

The --dest-dir (-d) option allows you to change the output directory for your book.


note: make sure to run the build command in the root directory and not in the source directory