mdbookshelf

Crates.iomdbookshelf
lib.rsmdbookshelf
version0.1.2
sourcesrc
created_at2019-04-21 22:42:30.397155
updated_at2019-12-31 07:45:05.345238
descriptionCreate epubs from a list of mdbook repositories
homepage
repositoryhttps://github.com/rams3s/mdbookshelf
max_upload_size
id129377
size132,178
(rams3s)

documentation

https://docs.rs/mdbookshelf/

README

MDBookshelf

Build Status

A Rust library/application to render a collection of books to EPUB using mdbook-epub. It uses Tera template engine to render an optional template.

Used to generate the Rust eBookshelf nightly.

Configuration

The configuration is handled through a bookshelf.toml file.

title = "The Rust Language & Ecosystem"
destination-dir = "out"
templates-dir = "templates"
working-dir = "tmp"

[[book]]
repo-url = "https://github.com/rust-lang/book.git"
url = "https://doc.rust-lang.org/stable/book/index.html"

[[book]]
repo-url = "https://github.com/rust-lang/rust-by-example.git"
url = "https://doc.rust-lang.org/stable/rust-by-example/"

[[book]]
repo-url = "https://github.com/rust-lang-nursery/rust-cookbook.git"
url = "https://github.com/rust-lang-nursery/rust-cookbook"

Usage

USAGE:
    mdbookshelf [OPTIONS]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -d, --destination_dir <DESTINATION_DIR>    Sets the destination directory
    -t, --templates_dir <TEMPLATES_DIR>        Sets the templates directory  (if not set, will generate manifest.json)
    -w, --working_dir <WORKING_DIR>            Sets a custom working directory where the book repositories will be
                                               cloned

The options can be used to override values specified in bookshelf.toml.

Contributions

  • Cleanup some code - this is my very first Rust code. I wrote this while still reading the Book (to be able to finish it on my Kindle). If you know of things that are not idiomatic or could be done better, please do not hesitate ;)
  • Fix a bug or implement a new thing
  • Make a Pull Request

Recent Changes

  • 0.1.1 Updated README
  • 0.1.0 First release

License

Licensed under the MIT license http://opensource.org/licenses/MIT. This file may not be copied, modified, or distributed except according to those terms.

Commit count: 47

cargo fmt