MDBook in mdbook_driver - Rust (original) (raw)

pub struct MDBook {
    pub root: PathBuf,
    pub config: Config,
    pub book: Book,
    /* private fields */
}

Expand description

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.

Source§

Source

Load a book from its root directory on disk.

Source

Load a book from its root directory using a custom Config.

Source

Load a book from its root directory using a custom Config and a custom summary.

Source

Returns a flat depth-first iterator over the BookItems of the book.

for item in book.iter() {
    match *item {
        BookItem::Chapter(ref chapter) => {},
        BookItem::Separator => {},
        BookItem::PartTitle(ref title) => {}
        _ => {}
    }
}

// would print something like this:
// 1. Chapter 1
// 1.1 Sub Chapter
// 1.2 Sub Chapter
// 2. Chapter 2
//
// etc.

Source

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.

Source

Tells the renderer to build our book and put it in the build directory.

Source

Run preprocessors and return the final book.

Source

Run the entire build process for a particular Renderer.

Source

You can change the default renderer to another one by using this method. The only requirement is that your renderer implement the Renderertrait.

Source

Register a Preprocessor to be used when rendering the book.

Source

Run rustdoc tests on the book, linking against the provided libraries.

Source

Run rustdoc tests on a specific chapter of the book, linking against the provided libraries. If chapter is None, all tests will be run.

Source

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 thebuild.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:

Source

Get the directory containing this book’s source files.

Source

Get the directory containing the theme resources for the book.

§

§

§

§

§

§