pub struct MDBook {
pub root: PathBuf,
pub config: Config,
pub book: Book,
// some fields omitted
}
The object used to manage and build a book.
The book's root directory.
The configuration used to tweak now a book is built.
A representation of the book's contents in memory.
Load a book from its root directory on disk.
Load a book from its root directory using a custom config.
Returns a flat depth-first iterator over the elements of the book,
it returns an BookItem enum:
(section: String, bookitem: &BookItem)
for item in book.iter() {
match *item {
BookItem::Chapter(ref chapter) => {},
BookItem::Separator => {},
}
}
init()
gives you a BookBuilder
which you can use to setup a new book
and its accompanying directory structure.
The BookBuilder
creates some boilerplate files and directories to get
you started with your book.
book-test/
├── book
└── src
├── chapter_1.md
└── SUMMARY.md
It uses the path provided as the root directory for your book, then adds
in a src/
directory containing a SUMMARY.md
and chapter_1.md
file
to get you started.
Tells the renderer to build our book and put it in the build directory.
You can change the default renderer to another one by using this method.
The only requirement is for your renderer to implement the Renderer
trait
Run rustdoc
tests on the book, linking against the provided libraries.
The logic for determining where a backend should put its build
artefacts.
If there is only 1 renderer, put it in the directory pointed to by the
build.build_dir
key in Config
. If there is more than one then the
renderer gets its own directory within the main build dir.
i.e. If there were only one renderer (in this case, the HTML renderer):
Otherwise if there are multiple:
Get the directory containing this book's source files.
Get the directory containing the theme resources for the book.
type Error = !
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
type Error = <U as TryFrom<T>>::Error
🔬 This is a nightly-only experimental API. (try_from
)
The type returned in the event of a conversion error.
🔬 This is a nightly-only experimental API. (try_from
)
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static