14 releases

0.4.37 Feb 9, 2024
0.4.34 Aug 7, 2023
0.4.32 Jul 17, 2023
0.4.27 Feb 20, 2023
0.1.0 Jan 26, 2018

#198 in Text processing

Download history 54/week @ 2023-11-02 71/week @ 2023-11-09 60/week @ 2023-11-16 48/week @ 2023-11-23 91/week @ 2023-11-30 27/week @ 2023-12-07 41/week @ 2023-12-14 61/week @ 2023-12-21 45/week @ 2023-12-28 49/week @ 2024-01-04 64/week @ 2024-01-11 130/week @ 2024-01-18 56/week @ 2024-01-25 47/week @ 2024-02-01 103/week @ 2024-02-08 289/week @ 2024-02-15

508 downloads per month
Used in mdbookshelf

MIT license

93KB
2K SLoC

MDBook EPUB Backend

  • Build Status
  • Build status
  • Rust

(Rendered Docs)

An experimental backend to mdbook which will render your document as an EPUB file, suitable for viewing on e-readers and other similar devices.

WARNING: Not yet production ready. May eat your laundry.

Note: At the moment the default stylesheet is quite bare bones, serving mainly to reset the styling used on various devices back to a known default. This default isn't overly pretty, so you may want to include your own stylesheets.

Getting Started

Before you can use the EPUB backend, you'll need to actually install it:

$ cargo install mdbook-epub

Next you need to let mdbook know to use the alternate renderer by updating your book.toml file. This is done by simply adding an empty output.epub table.

[book]
title = "mdBook Documentation"
description = "Create book from markdown files. Like Gitbook but implemented in Rust"
author = "Mathieu David"

[output.html]
mathjax-support = true

+ [output.epub]

Now everything is set up, just run mdbook as normal and the output directory (book/epub/ by default) should now contain an extra file called mdBook Documentation.epub (substituting in whatever your book's title is).

The mdbook-epub executable can be run in "standalone" mode. This is where the backend can be used without needing to be called by mdbook, useful if you only want to render the EPUB document.

$ mdbook-epub -s true ./path/to/book/dir
$ mdbook-epub --standalone true ./path/to/book/dir

Configuration

Configuration is fairly bare bones at the moment.

Recognized options:

additional-css: A list of paths to CSS stylesheets to include.

use-default-css: Controls whether to include the default stylesheet.

cover-image: A path to a cover image file for the ebook.

additional-resources: A list of path to files which should be added to the EPUB, such as typefaces. They will be added with path OEBPS/<filename>.

no-section-label: In the contents list, don't prefix the chapter title with its section number.

curly-quotes: Enable converting straight quotes 'x' and "x" to ‘x’ and “x” (aka smart quotes).

[output.epub]
additional-css = ["./path/to/main.css"]
use-default-css = false
cover-image = "ebook-cover.png"
additional-resources = ["./assets/Open-Sans-Regular.ttf"]
no-section-label = true
curly-quotes = true

Planned Features

The following features are planned (a checked box indicates it's complete). This list is by no means complete, so feature requests are most welcome!

  • Make a valid EPUB file with the bare chapter contents
  • Generate a basic TOC
  • Nested chapters - currently they're all inserted at the top level
  • Include a default CSS stylesheet (master.css)
    • Actually make that stylesheet pretty enough for human consumption
  • Include user-defined stylesheets and themes
  • Allow users to tweak the generated page by providing their own template
  • Ensure the generated document is viewable on the following platforms
    • Amazon Kindle
    • Sony PRS-T3

Contributing

This backend is still very much in the development phase and as such a large number of features are missing. If you think of something you'd like please create an issue on the issue tracker!

Dependencies

~16–29MB
~448K SLoC