Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hollowman6/mdbook-pdf
A backend for mdBook written in Rust for generating PDF based on headless chrome and Chrome DevTools Protocol. (用 Rust 编写的 mdBook 后端，基于headless chrome和Chrome开发工具协议生成PDF)
https://github.com/hollowman6/mdbook-pdf
book chromium hacktoberfest mdbook pdf rust rust-lang
Last synced: 5 days ago
JSON representation
A backend for mdBook written in Rust for generating PDF based on headless chrome and Chrome DevTools Protocol. (用 Rust 编写的 mdBook 后端，基于headless chrome和Chrome开发工具协议生成PDF)
- Host: GitHub
- URL: https://github.com/hollowman6/mdbook-pdf
- Owner: HollowMan6
- License: gpl-3.0
- Created: 2022-01-18T11:09:43.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-06T07:21:59.000Z (5 months ago)
- Last Synced: 2024-12-10T18:05:42.723Z (12 days ago)
- Topics: book, chromium, hacktoberfest, mdbook, pdf, rust, rust-lang
- Language: Rust
- Homepage: https://crates.io/crates/mdbook-pdf
- Size: 132 KB
- Stars: 157
- Watchers: 2
- Forks: 17
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# mdbook-pdf
[](https://hub.docker.com/r/hollowman6/mdbook-pdf)
[](https://github.com/HollowMan6/mdbook-pdf/graphs/commit-activity)
[](https://github.com/HollowMan6/mdbook-pdf/releases)
[](https://crates.io/crates/mdbook-pdf)
[](https://github.com/HollowMan6?tab=followers)
[](https://github.com/HollowMan6/mdbook-pdf/watchers)
[](https://github.com/HollowMan6/mdbook-pdf/stargazers)
[](https://github.com/HollowMan6/mdbook-pdf/network/members)
[](https://hollowman6.github.io/fund.html)
[](https://opensource.org/licenses/GPL-3.0/)
[](https://github.com/HollowMan6/mdbook-pdf/archive/master.zip)
[中文](https://github.com/HollowMan6/mdbook-pdf/blob/main/README_CN.md)
[Blog](https://hollowmansblog.wordpress.com/2022/01/30/mdbook-pdf-a-mdbook-backend-for-generating-pdf-files/)
A backend for [mdBook](https://github.com/rust-lang/mdBook) written in Rust for generating PDF based on [headless chrome](https://github.com/rust-headless-chrome/rust-headless-chrome) and [Chrome DevTools Protocol](https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-printToPDF).
## Installation & Usage
Since it's a plugin (backend) for [mdBook](https://github.com/rust-lang/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](https://github.com/HollowMan6/mdbook-pdf/actions/workflows/build.yml?query=is%3Asuccess)/[release](https://github.com/HollowMan6/mdbook-pdf/releases), 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](https://www.rust-lang.org/tools/install) 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](https://www.google.com/chrome/) / [Microsoft Edge](https://www.microsoft.com/en-us/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`:
```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`).
```toml
[output.html.print]
enable = true
```
A simplest `book.toml` is as follows:
```toml
[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](https://hub.docker.com/r/hollowman6/mdbook-pdf).
```bash
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.
```bash
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](https://github.com/HollowMan6/mdbook-pdf/blob/main/test_doc/book.toml#L10-L39) 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](https://chromedevtools.github.io/devtools-protocol/tot/Page/#method-printToPDF) according to its [documentation](https://pptr.dev/api/puppeteer.page.pdf), [rust-headless-chrome](https://github.com/rust-headless-chrome/rust-headless-chrome) doesn't.
2. Broken links!
I've already submitted [a PR for mdBook](https://github.com/rust-lang/mdBook/pull/1738) 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](https://github.com/HollowMan6/mdBook) for this to work.
If you have relative links that link outside the book, please provide the [static hosting site URL](https://github.com/HollowMan6/mdbook-pdf/blob/main/test_doc/book.toml#L19-L20) for it to get fixed.
3. Can you add the bookmark to the PDF reflecting the Table of Contents, just like what [wkhtmltopdf](https://wkhtmltopdf.org/) is supported?
~~This should be realized by Chromium, and an issue has already been filed for this [here](https://issues.chromium.org/issues/40038778).~~
Initial support for the bookmark/outline of the PDF file has already been available ([mdbook-pdf-outline](https://pypi.org/project/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](https://github.com/rust-lang/mdBook/pull/1738) 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]***:
```toml
[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`:
```toml
[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](https://github.com/HollowMan6/mdbook-pdf/discussions/9#discussioncomment-4895678), you can use the following syntax to force page breaks in the markdown source:
```markdown
```
5. Failed to render my book for PDF in `mdbook-pdf`!
Will appreciate if you can report it to the [issue tracker](https://github.com/HollowMan6/mdbook-pdf/issues/new) 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.
```bash
RUST_BACKTRACE=full RUST_LOG=trace mdbook build
```