38b3516b60
This project already had a transitive dependency on regex; let's use it. This isn't the most efficient solution, but it should be fine. It ends up doing five full scans of the text. There's probably an easier way but I'm mostly just trying to get this to work for now. This also implements the same algorithm that rustdoc does for generating the name for the link. Fixes #204
89 lines
2.7 KiB
Rust
89 lines
2.7 KiB
Rust
//! # mdBook
|
|
//!
|
|
//! **mdBook** is similar to Gitbook but implemented in Rust.
|
|
//! It offers a command line interface, but can also be used as a regular crate.
|
|
//!
|
|
//! This is the API doc, but you can find a [less "low-level" documentation here](../index.html) that
|
|
//! contains information about the command line tool, format, structure etc.
|
|
//! It is also rendered with mdBook to showcase the features and default theme.
|
|
//!
|
|
//! Some reasons why you would want to use the crate (over the cli):
|
|
//!
|
|
//! - Integrate mdbook in a current project
|
|
//! - Extend the capabilities of mdBook
|
|
//! - Do some processing or test before building your book
|
|
//! - Write a new Renderer
|
|
//! - ...
|
|
//!
|
|
//! ## Example
|
|
//!
|
|
//! ```no_run
|
|
//! extern crate mdbook;
|
|
//!
|
|
//! use mdbook::MDBook;
|
|
//! use std::path::Path;
|
|
//!
|
|
//! fn main() {
|
|
//! let mut book = MDBook::new(Path::new("my-book")) // Path to root
|
|
//! .set_src(Path::new("src")) // Path from root to source directory
|
|
//! .set_dest(Path::new("book")) // Path from root to output directory
|
|
//! .read_config(); // Parse book.json file for configuration
|
|
//!
|
|
//! book.build().unwrap(); // Render the book
|
|
//! }
|
|
//! ```
|
|
//!
|
|
//! ## Implementing a new Renderer
|
|
//!
|
|
//! If you want to create a new renderer for mdBook, the only thing you have to do is to implement
|
|
//! the [Renderer trait](renderer/renderer/trait.Renderer.html)
|
|
//!
|
|
//! And then you can swap in your renderer like this:
|
|
//!
|
|
//! ```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.
|
|
//!
|
|
//! ## utils
|
|
//!
|
|
//! I have regrouped some useful functions in the [utils](utils/index.html) module, like the following function
|
|
//!
|
|
//! ```ignore
|
|
//! utils::fs::create_path(path: &Path)
|
|
//! ```
|
|
//! This function creates all the directories in a given path if they do not exist
|
|
//!
|
|
//! Make sure to take a look at it.
|
|
|
|
extern crate serde;
|
|
#[macro_use]
|
|
extern crate serde_json;
|
|
extern crate handlebars;
|
|
extern crate pulldown_cmark;
|
|
extern crate regex;
|
|
|
|
#[macro_use] extern crate log;
|
|
pub mod book;
|
|
mod parse;
|
|
pub mod renderer;
|
|
pub mod theme;
|
|
pub mod utils;
|
|
|
|
pub use book::MDBook;
|
|
pub use book::BookItem;
|
|
pub use book::BookConfig;
|
|
pub use renderer::Renderer;
|