Fixed the code examples and added no_run to prevent them from running

This commit is contained in:
Mathieu David 2015-08-06 15:04:27 +02:00
parent 731149d37a
commit 20bfcd128d
2 changed files with 20 additions and 3 deletions

View file

@ -9,6 +9,9 @@ handlebars = "*"
rustc-serialize = "*"
pulldown-cmark = "*"
[dev-dependencies]
tempdir = "*"
[features]
default = ["output"]
debug = []

View file

@ -17,7 +17,7 @@
//!
//! ## Example
//!
//! ```ignore
//! ```no_run
//! extern crate mdbook;
//!
//! use mdbook::MDBook;
@ -41,9 +41,23 @@
//!
//! And then you can swap in your renderer like this:
//!
//! ```ignore
//! let book = MDBook::new("my-book").set_renderer(your_renderer)
//! ```no_run
//! # extern crate mdbook;
//! #
//! # use mdbook::MDBook;
//! # use mdbook::renderer::HtmlHandlebars;
//! # use std::path::Path;
//! #
//! # fn main() {
//! # let your_renderer = HtmlHandlebars::new();
//! #
//! let book = MDBook::new(Path::new("my-book")).set_renderer(Box::new(your_renderer));
//! # }
//! ```
//! If you make a renderer, you get the book constructed in form of `Vec<BookItems>` and you get
//! the book config in a `BookConfig` struct.
//!
//! It's your responsability to create the necessary files in the correct directories.
#[macro_use]