There is some minimal boilerplate that is the same for every new book. It's for
this purpose that mdBook includes an
init command is used like this:
When using the
init command for the first time, a couple of files will be set
up for you:
book-test/ ├── book └── src ├── chapter_1.md └── SUMMARY.md
srcdirectory is where you write your book in markdown. It contains all the source files, configuration files, etc.
bookdirectory is where your book is rendered. All the output is ready to be uploaded to a server to be seen by your audience.
SUMMARY.mdis the skeleton of your book, and is discussed in more detail in another chapter.
SUMMARY.md file already exists, the
init command will first parse it
and generate the missing files according to the paths used in the
This allows you to think and create the whole structure of your book and then
let mdBook generate it for you.
init command can take a directory as an argument to use as the book's root
instead of the current working directory.
mdbook init path/to/book
When you use the
--theme flag, the default theme will be copied into a
theme in your source directory so that you can modify it.
The theme is selectively overwritten, this means that if you don't want to overwrite a specific file, just delete it and the default file will be used.
Specify a title for the book. If not supplied, an interactive prompt will ask for a title.
mdbook init --title="my amazing book"
.gitignore file configured to ignore the
book directory created when building a book.
If not supplied, an interactive prompt will ask whether it should be created.
mdbook init --ignore=none
mdbook init --ignore=git
Skip the prompts to create a
.gitignore and for the title for the book.