mdbook-pdf-outline 0.1.6

Tool for generating outlines for PDF files generated by mdbook-pdf.

mdbook-pdf

中文

Blog

A backend for mdBook written in Rust for generating PDF based on headless chrome and Chrome DevTools Protocol.

Installation & Usage

Since it's a plugin (backend) for mdBook, first of all you should ensure that mdbook is available.

If your machine's architecture is x86_64, or you are using Linux for ARM64, check the successful build GitHub Actions workflows/release, click into the latest one, and then you can get a binary from the Artifacts (including Windows, Linux, macOS).

Otherwise, make sure the rust compiling environment is available, execute cargo install mdbook-pdf to compile and install.

If you want to compile the latest version, make sure the Rust build environment is available (cargo build). Run cargo install --git https://github.com/HollowMan6/mdbook-pdf.git, or alternatively, you can clone the repository and compile it yourself. (Run git clone https://github.com/HollowMan6/mdbook-pdf.git, in the cloned folder, run cargo build --release , get the executable in target/release/, and put it in PATH)

For running, please have Google Chrome / Chromium / Microsoft Edge already available (installed at the default location, in PATH or binary location configured). If not, and mdbook-pdf has the fetch feature enabled (It is not enabled by default, you need to use cargo install mdbook-pdf --features fetch to recompile for enabling), the program will try to automatically download the Chromium browser and run it (Note: if you are on Linux, there may be problems if chromium dependencies are not satisfied / using non-x86_64 architectures).

• On Windows 10 and above, the program can generate PDF normally without installing any additional software, because Microsoft Edge is the browser provided with Windows system. Of course, considering the support for the older versions of Windows without Edge, you can install Google Chrome on your computer.
• In MacOS, you need to install Google Chrome / Microsoft Edge or Chromium.
• In Linux, you can choose to install any of the Google Chrome / Chromium / Microsoft Edge browsers. It is recommended to install Chromium. The name of this software package in your Linux distribution is commonly chromium or chromium-browser (Note: for Ubuntu later than 18.04, you have to install chromium-browser through snap).

Make sure the following exists in your book.toml:

[output.html]

[output.pdf]

And also [output.html.print] is not disabled (it should be enabled by default, so don't worry if the following lines doesn't occur in you book.toml).

[output.html.print]
enable = true

A simplest book.toml is as follows:

[book]
title = "An Example"

[output.html]

[output.pdf]

Finally you can build your book and get the PDF file with mdbook build command, your PDF file will be available at book/pdf/output.pdf.

Run with Docker

You can also use this docker image.

docker run --rm -v /path/to/book:/book hollowman6/mdbook-pdf

If your book have other Rust dependencies, you can install them on your local machine (if using Linux), or if you are not using Linux, download the Linux executables of corresponding architecture to a dir, replace ~/.cargo/bin with your path.

docker run --rm -v /path/to/book:/book -v ~/.cargo/bin:/mdbook hollowman6/mdbook-pdf

Configuration

Support customize PDF paper orientation, scale of the webpage rendering, paper width and height, page margins, generated PDF page ranges, whether to display header and footer as well as customize their formats, and more.

Check book.toml and comments for details for the available configurations of [output.pdf].

Common Issues

1. Support for Firefox in mdbook-pdf!

Currently, although Puppeteer supports something similar to Chrome DevTools Protocol Page.printToPDF according to its documentation, rust-headless-chrome doesn't.

2. Broken links!

I've already submitted a PR for mdBook to fix this by making print page (print.html) links link to anchors on the print page, but it's not merged yet. You can try my PR fork for this to work.

If you have relative links that link outside the book, please provide the static hosting site URL for it to get fixed.

3. Can you add the bookmark to the PDF reflecting the Table of Contents, just like what wkhtmltopdf is supported?

This has already been realized by Chromium, in v0.1.11+, you can control it by the generate-document-outline option.

[!NOTE] If you dislike the Chromium generated Table of Contents, we also have support for the bookmark/outline of the PDF file (mdbook-pdf-outline). It is written in Python and is another backend for mdbook and should be used with mdbook-pdf and the modified mdbook mentioned in Common Issues 2 (by cargo install --git https://github.com/HollowMan6/mdBook mdbook instead) for fixing the broken links in print.html.

You can install this backend by pip install mdbook-pdf-outline.

Remember to put the following to the end of your book.toml, after [output.pdf], and disable the generate-document-outline option:

generate-document-outline = false

[output.pdf-outline]

If you want to use the table of content just like the one shown in the print.html page for PDF file, you can leave the book.toml as it is.

If you prefer to use the table of content just like the one generated by wkhtmltopdf (generate entries based on the headings), you can turn on the like-wkhtmltopdf option by using the following to your book.toml:

generate-document-outline = false

[output.pdf-outline]
like-wkhtmltopdf = true

Finally, you can find the outlined version at book/pdf-outline/output.pdf.

4. Force page breaks in the markdown source that is respected by mdbook-pdf!

Referring to #9, you can use the following syntax to force page breaks in the markdown source:

<div style="page-break-before:always">&nbsp;</div>
<p></p>

5. Failed to render my book for PDF in mdbook-pdf!

Will appreciate if you can report it to the issue tracker providing all the traces for mdbook-pdf rendering as well as your book.toml. You can also provide the link to your book's repository if it's open source.

RUST_BACKTRACE=full RUST_LOG=trace mdbook build